From 6b52bf6f63c47578e6800083b12bd7be3874e1db Mon Sep 17 00:00:00 2001 From: cage Date: Sun, 3 Jan 2021 17:55:02 +0100 Subject: [PATCH] - updated README and FAQ. --- README.org | 23 ++++++++++++++++++++++- README.txt | 25 ++++++++++++++++++++++++- 2 files changed, 46 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index c39b149..06e0f6f 100644 --- a/README.org +++ b/README.org @@ -50,6 +50,9 @@ - xdg-open; - your favourite editor (default: nano). +All the dependencies above should be available using the package +manager of your distribution (~apt~, ~yum~ etc). + ** Lisp Libraries - alexandria; @@ -77,6 +80,9 @@ - crypto-shortcuts; - drakma. + All these libraries will be downloaded, compiled and installed by + the script ~quick_quicklisp.sh~, see below. + ** Foreign (C language) library - libssl (TLS socket) @@ -129,7 +135,13 @@ $ make install #+END_SRC - 7. run the software! + 7. take a look the manpage: + + #+BEGIN_SRC sh + $ man tinmop + #+END_SRC + + 8. run the software! #+BEGIN_SRC sh $ tinmop @@ -201,6 +213,15 @@ * FAQ + - The ~quick_quicklisp.sh~ script failed and refuse to start again, + what can I do? + + If tinmop is the first Common lisp program you have ever installed + installed, try to rename the directory ~$/HOME/quicklisp~ and, + then, restart the script. + + If problem persists [[BUGS][contact me]]. + - Is tinmop compatible with mastodon servers? Unfortunately no, the way some API endpoint provide the toots is diff --git a/README.txt b/README.txt index d2ef500..09890ee 100644 --- a/README.txt +++ b/README.txt @@ -88,6 +88,9 @@ Table of Contents • xdg-open; • your favourite editor (default: nano). + All the dependencies above should be available using the package + manager of your distribution (`apt', `yum' etc). + 3.2 Lisp Libraries ────────────────── @@ -117,6 +120,9 @@ Table of Contents • crypto-shortcuts; • drakma. + All these libraries will be downloaded, compiled and installed by the + script `quick_quicklisp.sh', see below. + 3.3 Foreign (C language) library ──────────────────────────────── @@ -174,7 +180,13 @@ Table of Contents │ $ make install └──── - 7. run the software! + 7. take a look the manpage: + + ┌──── + │ $ man tinmop + └──── + + 8. run the software! ┌──── │ $ tinmop @@ -270,6 +282,15 @@ Table of Contents 11 FAQ ══════ + • The `quick_quicklisp.sh' script failed and refuse to start again, + what can I do? + + If tinmop is the first Common lisp program you have ever installed + installed, try to rename the directory `$/HOME/quicklisp' and, then, + restart the script. + + If problem persists [contact me]. + • Is tinmop compatible with mastodon servers? Unfortunately no, the way some API endpoint provide the toots is not @@ -322,6 +343,8 @@ Table of Contents So, please do not consider the encrypted message secure at all. +[contact me] See section 6 + [here]