diff --git a/README.org b/README.org index f786239..202afc1 100644 --- a/README.org +++ b/README.org @@ -4,8 +4,8 @@ * Introduction - Tinmop is an opinionated client for Mastodon (or Pleroma using the - mastodon API). It offer a distraction free terminal interface. + Tinmop is an opinionated client for Pleroma (using the mastodon + API). It offer a distraction free terminal interface. The name is a recursive acronym: "Tinmop Is Not Mutt or Pine". The older of us can remember that, in turn, Pine is sometimes considered @@ -200,10 +200,19 @@ * FAQ + - Is tinmop compatible with mastodon servers? + + Unfortunately no, the way some API endpoint provide the toots is + not suitable for this client, for more information please go + [[https://github.com/tootsuite/mastodon/issues/13817][here]]. + + I hope this will change in the future but this depends entirely + from the people are developing the server. + - I just tried to start the program for the first time but it give me a weird error, what's wrong? - Did you wrote a configuration file? + Did you wrote a configuration file before starting? Tinmop expects a configuration file in your config directory (usually ~$HOME/.config/tinmop/~). This file must contains at diff --git a/README.txt b/README.txt index 26f53a9..d8395c0 100644 --- a/README.txt +++ b/README.txt @@ -31,8 +31,8 @@ Table of Contents 1 Introduction ══════════════ - Tinmop is an opinionated client for Mastodon (or Pleroma using the - mastodon API). It offer a distraction free terminal interface. + Tinmop is an opinionated client for Pleroma (using the mastodon + API). It offer a distraction free terminal interface. The name is a recursive acronym: "Tinmop Is Not Mutt or Pine". The older of us can remember that, in turn, Pine is sometimes considered @@ -268,10 +268,18 @@ Table of Contents 11 FAQ ══════ + • Is tinmop compatible with mastodon servers? + + Unfortunately no, the way some API endpoint provide the toots is not + suitable for this client, for more information please go [here]. + + I hope this will change in the future but this depends entirely from + the people are developing the server. + • I just tried to start the program for the first time but it give me a weird error, what's wrong? - Did you wrote a configuration file? + Did you wrote a configuration file before starting? Tinmop expects a configuration file in your config directory (usually `$HOME/.config/tinmop/'). This file must contains at least @@ -312,6 +320,9 @@ Table of Contents So, please do not consider the encrypted message secure at all. +[here] + + 12 NO WARRANTY ══════════════ diff --git a/doc/man.org b/doc/man.org index 1f073f7..cbc543f 100644 --- a/doc/man.org +++ b/doc/man.org @@ -12,8 +12,8 @@ information about this topic can be found on the official website ([[https://docs.joinmastodon.org/]]). - Tinmop propose a terminal interface to to connect with Mastodon or - Pleroma social network + Tinmop proposes a terminal interface to to connect with Pleroma + social network * Options Without options the program will start a terminal interface and will @@ -33,7 +33,7 @@ * Usage - Users of Tinmop supposed to interacts with the social network + Users of Tinmop supposed to interact with the social network using a terminal interface (TUI), The terminal screen layout is sketched below: diff --git a/doc/tinmop.man b/doc/tinmop.man index ab943af..3c700db 100644 --- a/doc/tinmop.man +++ b/doc/tinmop.man @@ -15,8 +15,8 @@ information about this topic can be found on the official website (\fIhttps://docs.joinmastodon.org/\fP). .PP -Tinmop propose a terminal interface to to connect with Mastodon or -Pleroma social network +Tinmop proposes a terminal interface to to connect with Pleroma +social network .SH "Options" .PP @@ -52,7 +52,7 @@ Print program version and exit .SH "Usage" .PP -Users of Tinmop supposed to interacts with the social network +Users of Tinmop supposed to interact with the social network using a terminal interface (TUI), The terminal screen layout is sketched below: