Fix missing mentions field in test Msg construction
[tt.git] / README.md
index 4ad9649..830d08c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,10 +22,17 @@ 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`.
+`make build && make install` will build and copy `tt` binary into
+`$PREFIX/bin`, where `$PREFIX` defaults to `$HOME`.
 
 ### configuration
 Put your `<nick>` and `<uri>` into `~/.tt/me`. For example, mine is:
@@ -40,10 +47,10 @@ if omitted, you'll stay anonymous.
 
 ### usage
 Download feeds from the Internet:
-`tt d (FOLLOW-FILE)`
+`tt d [FOLLOW-FILE ... ]`
 
 Read your timeline:
-`tt r (FOLLOW-FILE)`
+`tt r [FOLLOW-FILE ... ]`
 
 `FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like:
 
@@ -51,6 +58,8 @@ Read your timeline:
 xandkar https://xandkar.net/twtxt.txt
 ```
 
+If omitted, `FOLLOW-FILE` defaults to `~/.tt/peers`.
+
 See the rest of the usage options:
 `tt -h`
 
@@ -61,7 +70,7 @@ notes
 -----
 
 ### LWW downloads
-Downloaded timelines are stored in `~/.tt/cache/<SHA1_OF_URI>`, but no attempt
-is made to preserve the previously-downloaded messages - each download
-overrites the previous. One of the implications is that authors can edit/delete
-history without you noticing.
+Downloaded timelines are stored in `~/.tt/cache/objects/<URL_ENCODED_URL>`, but
+no attempt is made to preserve the previously-downloaded messages - each
+download overrites the previous. One of the implications is that authors can
+edit/delete history without you noticing.
This page took 0.027906 seconds and 4 git commands to generate.