Merge pull request #77 from nloadholtes/curses-docs

Updating the docs with information about and commands for the curses UI
This commit is contained in:
Ivan Habunek 2018-12-30 22:31:28 +01:00 committed by GitHub
commit 5e7b4d3d88
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions

View File

@ -99,3 +99,20 @@ It is possible to pipe in the status text:
echo "Text to post" | toot post
cat post.txt | toot post
toot post < post.txt
Using the Curses UI
~~~~~~~
toot has an expimental curses based console UI. The command to start it is ``toot curses``.
To navigate the UI use these commands:
* ``k`` or ``up arrow`` to move up the list of tweets
* ``j`` or ``down arrow`` to move down the list of tweets
* ``h`` to show a help screen
* ``v`` to view the current toot in a browser (this is great for seeing the comment thread on a toot)
* ``q`` to quit the curses interface and return to the command line
* ``s`` to show sensitive content. (This is per-toot, and there will be a read bar in the toot to indicate that it is there.)
*Note that the curses UI is not available on Windows.*