X-Git-Url: https://git.xandkar.net/?a=blobdiff_plain;f=README.md;h=daf8ff8bdb8b8e88cf2fc7f9e38d093e3eb5ab46;hb=refs%2Ftags%2F0.18.0;hp=0a75994117ab299664464fcce2b02e30715deb5f;hpb=6df41218feef6f9a5fb726a49abfbdf4f80b5030;p=tt.git diff --git a/README.md b/README.md index 0a75994..daf8ff8 100644 --- a/README.md +++ b/README.md @@ -11,22 +11,57 @@ This means unlimited possibilities for ad-hoc, interesting filtering combinations. Especially when paired with [process substitution](https://en.wikipedia.org/wiki/Process_substitution). -![Screenshot](screenshot-multi.jpg) +### long format (default) +![Screenshot](screenshot-long.jpg) + +### short format (CLI option: -s) +![Screenshot](screenshot-short.jpg) instructions ------------ ### requirements + +#### manual [Racket](https://download.racket-lang.org/) +#### package manager +- Void Linux: `xbps-install racket` +- Debian: `apt install racket` + ### installation -1. Run `make install` or `raco pkg install` -2. Add `$HOME/.racket/7.9/bin` to your `$PATH` - (replacing `7.9` with whatever version you have installed) +`make build && make install` will build and copy `tt` binary into +`$PREFIX/bin`, where `$PREFIX` defaults to `$HOME`. + +### configuration +Put your `` and `` into `~/.tt/me`. For example, mine is: + +``` +$ cat ~/.tt/me +xandkar https://xandkar.net/twtxt.txt +``` +It will be used to fill the `User-Agent` header, so that others can tell you're +reading their twtxts and perhaps read yours. This isn't strictly necessary and +if omitted, you'll stay anonymous. ### usage -`tt (FOLLOW-FILE)` +Download feeds from the Internet: +`tt d (FOLLOW-FILE)` + +Read your timeline: +`tt r (FOLLOW-FILE)` + +`FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like: + +``` +xandkar https://xandkar.net/twtxt.txt +``` + +See the rest of the usage options: +`tt -h` + +`tt -h` notes