README.md

   1 tt
   2 ==
   3 A more-unixy [twtxt](https://github.com/buckket/twtxt) client.
   4
   5 [![Build Status](https://travis-ci.org/xandkar/tt.svg?branch=master)](https://travis-ci.org/xandkar/tt)
   6
   7 Doesn't force you to maintain a master "following" file (the way Twitter does),
   8 but let's you point it to any follow-file every time it runs.
   9
  10 This means unlimited possibilities for ad-hoc, interesting filtering
  11 combinations. Especially when paired with
  12 [process substitution](https://en.wikipedia.org/wiki/Process_substitution).
  13
  14 ### long format (default)
  15 ![Screenshot](screenshot-long.jpg)
  16
  17 ### short format (CLI option: -s)
  18 ![Screenshot](screenshot-short.jpg)
  19
  20
  21 instructions
  22 ------------
  23
  24 ### requirements
  25
  26 #### manual
  27 [Racket](https://download.racket-lang.org/)
  28
  29 #### package manager
  30 - Void Linux: `xbps-install racket`
  31 - Debian: `apt install racket`
  32
  33 ### installation
  34 `make build && make install` will build and copy `tt` binary into
  35 `$PREFIX/bin`, where `$PREFIX` defaults to `$HOME`.
  36
  37 ### configuration
  38 Put your `<nick>` and `<uri>` into `~/.tt/me`. For example, mine is:
  39
  40 ```
  41 $ cat ~/.tt/me
  42 xandkar https://xandkar.net/twtxt.txt
  43 ```
  44 It will be used to fill the `User-Agent` header, so that others can tell you're
  45 reading their twtxts and perhaps read yours. This isn't strictly necessary and
  46 if omitted, you'll stay anonymous.
  47
  48 ### usage
  49 Download feeds from the Internet:
  50 `tt d [FOLLOW-FILE ... ]`
  51
  52 Read your timeline:
  53 `tt r [FOLLOW-FILE ... ]`
  54
  55 `FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like:
  56
  57 ```
  58 xandkar https://xandkar.net/twtxt.txt
  59 ```
  60
  61 If omitted, `FOLLOW-FILE` defaults to `~/.tt/peers`.
  62
  63 See the rest of the usage options:
  64 `tt -h`
  65
  66 `tt <command> -h`
  67
  68
  69 notes
  70 -----
  71
  72 ### LWW downloads
  73 Downloaded timelines are stored in `~/.tt/cache/objects/<URL_ENCODED_URL>`, but
  74 no attempt is made to preserve the previously-downloaded messages - each
  75 download overrites the previous. One of the implications is that authors can
  76 edit/delete history without you noticing.