Add Racket install instructions for a couple of pkg managers
[tt.git] / README.md
index 1daf22d..b6cb42e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,11 +22,28 @@ instructions
 ------------
 
 ### requirements
+
+#### manual
 [Racket](https://download.racket-lang.org/)
 
+#### package manager
+- Void Linux: `xbps-install racket`
+- Debian: `apt install racket`
+
 ### installation
 `make build && make install` will build and copy `tt` binary into `$PREFIX/bin`.
 
+### configuration
+Put your `<nick>` and `<uri>` 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
 Download feeds from the Internet:
 `tt d (FOLLOW-FILE)`
@@ -34,6 +51,12 @@ Download feeds from the Internet:
 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`
 
This page took 0.028431 seconds and 4 git commands to generate.