Browse Source

AUR package

pull/8/head
Rasmus Lindroth 6 years ago committed by GitHub
parent
commit
98cbabfb74
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 17
      README.md

17
README.md

@ -8,7 +8,7 @@ You can find Linux binaries under [releases](https://github.com/RasmusLindroth/t
![Preview](./images/preview.png "Preview")
### Currently supported commands
## Currently supported commands
* `:q` `:quit` exit
* `:timeline` home, local, federated, direct, notifications
* `:tl` h, l, f, d, n (a shorter form of the former)
@ -20,14 +20,21 @@ Explanation of the non obvious keys when viewing a toot
an user or tag they will be opened in tut.
* `M` = media. Opens the media with `xdg-open`.
### Configuration
## Configuration
Tut if configurable, so you can change things like the colors, the default timeline,
what image viewer to use and some more. Check out the configuration file to see
all the options.
You find it in `XDG_CONFIG_HOME/tut/config.ini` which usally equals to `~/.config/tut/config.ini`.
### Install instructions
## Install instructions
### Using Arch?
You can find it in the Arch User Repository (AUR).
https://aur.archlinux.org/packages/tut/
## Build it yourself
If you don't use the binary that you find under releases
you will need Go. Use a newer one that supports modules.
@ -52,13 +59,13 @@ you will have to add `go/bin` to your `$PATH`.
### On my TODO-list:
## On my TODO-list:
* Multiple accounts
* Support search
* Support lists
* Better error handling (in other words, don't crash the whole program)
### Thanks to
## Thanks to
* [mattn/go-mastodon](https://github.com/mattn/go-mastodon) - used to make calls to the Mastodon API
* [rivo/tview](https://github.com/rivo/tview) - used to make the TUI
* [gdamore/tcell](https://github.com/gdamore/tcell) - used by tview under the hood

Loading…
Cancel
Save