X-Git-Url: https://git.xandkar.net/?a=blobdiff_plain;f=README.md;h=10b615a0be75ea4a0f07f05154f39aabce39d7e1;hb=HEAD;hp=3c8630d2821e1208b4644c4d8cf13d8c0ff57193;hpb=58b95fe23b6842071e92f3058f704bcbd0b1c3ad;p=tt.git

diff --git a/README.md b/README.md
index 3c8630d..10b615a 100644
--- a/README.md
+++ b/README.md
@@ -22,31 +22,92 @@ 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 `<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)`
 
-Read your timeline:
-`tt r (FOLLOW-FILE)`
+		$ tt --help
+		tt [ <option> ... ] <command> [<args>] ...
+		 where <option> is one of
+			-d, --debug : Enable debug log level.
+
+		 and <command> is one of
+		 r, read     : Read the timeline (offline operation).
+		 d, download : Download the timeline.
+		 u, upload   : Upload your twtxt file (alias to execute ~/.tt/upload).
+		 c, crawl    : Discover new peers mentioned by known peers (offline operation).
+
+			--help, -h : Show this help
+			-- : Do not treat any remaining argument as a switch (at this level)
+		 Multiple single-letter switches can be combined after one `-'; for
+			example: `-h-' is the same as `-h --'
+
+#### download
+peers' feeds from the Internet:
+
+		$ tt d -h
+		tt download [ <option> ... ] [<file-paths>] ...
+		 where <option> is one of
+			-j <njobs>, --jobs <njobs> : Number of concurrent jobs.
+			--help, -h : Show this help
+			-- : Do not treat any remaining argument as a switch (at this level)
+		 Multiple single-letter switches can be combined after one `-'; for
+			example: `-h-' is the same as `-h --'
+
+#### read
+your timeline:
+
+		$ tt r -h
+		tt read [ <option> ... ] [<file-paths>] ...
+		 where <option> is one of
+			-r, --rev : Reverse displayed timeline order.
+		/ -s, --short : Short output format
+		\ -l, --long : Long output format
+			--help, -h : Show this help
+			-- : Do not treat any remaining argument as a switch (at this level)
+		 /|\ Brackets indicate mutually exclusive options.
+		 Multiple single-letter switches can be combined after one `-'; for
+			example: `-h-' is the same as `-h --'
+
+`FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like:
+
+```
+xandkar https://xandkar.net/twtxt.txt
+```
+
+If omitted, `FOLLOW-FILE` defaults to `~/.tt/peers`.
 
-See the rest of the usage options:
-`tt -h`
+#### other commands
 
-`tt <command> -h`
+    tt <command> -h
 
 
 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.