From 68b7ac7c3b762bca3866c5398c1c276d390ec1f8 Mon Sep 17 00:00:00 2001 From: Lynnesbian Date: Tue, 10 Mar 2020 17:15:23 +1000 Subject: [PATCH] improved readme with more info about some common issues --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4124f64..45a873b 100644 --- a/README.md +++ b/README.md @@ -12,23 +12,23 @@ This version makes quite a few changes from [the original](https://github.com/Je An installation and usage guide is available [here](https://cloud.lynnesbian.space/s/jozbRi69t4TpD95). It's primarily targeted at Linux, but it should be possible on BSD, macOS, etc. I've also put some effort into providing steps for Windows, but I can't make any guarantees as to its effectiveness. ## Compatibility -| Software | Downloading statuses | Posting | Replying | -|-----------|----------------------|---------|-------------------------------------------------------------| -| Mastodon | Yes | Yes | Yes | -| Pleroma | Somewhat | Yes | [No](https://git.pleroma.social/pleroma/pleroma/issues/416) | -| Misskey | Yes | No | No | -| diaspora* | No | No | No | -| Others | Probably | No | No | +| Software | Downloading statuses | Posting | Replying | +|-----------|-------------------------------------------------------------------|---------|-------------------------------------------------------------| +| Mastodon | Yes | Yes | Yes | +| Pleroma | [Somewhat](https://git.pleroma.social/pleroma/pleroma/issues/866) | Yes | [No](https://git.pleroma.social/pleroma/pleroma/issues/416) | +| Misskey | Yes | No | No | +| diaspora* | No | No | No | +| Others | Maybe | No | No | ## Configuration Configuring mstdn-ebooks is accomplished by editing `config.json`. If you want to use a different file for configuration, specify it with the `--cfg` argument. For example, if you want to use `/home/lynne/c.json` instead, you would run `python3 main.py --cfg /home/lynne/c.json` instead of just `python3 main.py` | Setting | Default | Meaning | |--------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| site | https://botsin.space | The instance your bot will log in to and post from. | +| site | https://botsin.space | The instance your bot will log in to and post from. This must start with `https://` or `http://` (preferably the latter) | | cw | null | The content warning (aka subject) mstdn-ebooks will apply to non-error posts. | -| instance_blacklist | ["bofa.lol", "witches.town", "knzk.me"] | If your bot is following someone from a blacklisted instance, it will skip over them and not download their posts. This is useful for ensuring that mstdn-ebooks doesn't download posts from dead instances, without you having to unfollow the user(s) from them. | +| instance_blacklist | ["bofa.lol", "witches.town", "knzk.me"] | If your bot is following someone from a blacklisted instance, it will skip over them and not download their posts. This is useful for ensuring that mstdn-ebooks doesn't waste time trying to download posts from dead instances, without you having to unfollow the user(s) from them. | | learn_from_cw | false | If true, mstdn-ebooks will learn from CW'd posts. | | mention_handling | 1 | 0: Never use mentions. 1: Only generate fake mentions in the middle of posts, never at the start. 2: Use mentions as normal (old behaviour). | | max_thread_length | 15 | The maximum number of bot posts in a thread before it stops replying. A thread can be 10 or 10000 posts long, but the bot will stop after it has posted `max_thread_length` times. | -| strip_paired_punctuation | false | If true, mstdn-ebooks will remove punctuation that commonly appears in pairs, like " and (). This avoids the issue of posts that open a bracket without closing it. | +| strip_paired_punctuation | false | If true, mstdn-ebooks will remove punctuation that commonly appears in pairs, like " and (). This avoids the issue of posts that open a bracket (or quote) without closing it. |