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 `$PREFIX/bin`.
  35
  36 ### configuration
  37 Put your `<nick>` and `<uri>` into `~/.tt/me`. For example, mine is:
  38
  39 ```
  40 $ cat ~/.tt/me
  41 xandkar https://xandkar.net/twtxt.txt
  42 ```
  43 It will be used to fill the `User-Agent` header, so that others can tell you're
  44 reading their twtxts and perhaps read yours. This isn't strictly necessary and
  45 if omitted, you'll stay anonymous.
  46
  47 ### usage
  48 Download feeds from the Internet:
  49 `tt d (FOLLOW-FILE)`
  50
  51 Read your timeline:
  52 `tt r (FOLLOW-FILE)`
  53
  54 `FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like:
  55
  56 ```
  57 xandkar https://xandkar.net/twtxt.txt
  58 ```
  59
  60 See the rest of the usage options:
  61 `tt -h`
  62
  63 `tt <command> -h`
  64
  65
  66 notes
  67 -----
  68
  69 ### LWW downloads
  70 Downloaded timelines are stored in `~/.tt/cache/<SHA1_OF_URI>`, but no attempt
  71 is made to preserve the previously-downloaded messages - each download
  72 overrites the previous. One of the implications is that authors can edit/delete
  73 history without you noticing.