From 82bdc852ed9019e70b903fb54b7c8f8ac1c3ee2d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 11 Nov 2023 09:25:17 +0000 Subject: [PATCH] toot-together setup --- toots/README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 toots/README.md diff --git a/toots/README.md b/toots/README.md new file mode 100644 index 0000000..b2c6f32 --- /dev/null +++ b/toots/README.md @@ -0,0 +1,39 @@ +# The toots/ folder + +To create a new toot create a new `*.toot` file in this `toots/` folder. + +[Create new toot](../../../new/master/?filename=toots/.toot) + +## Example + +Create a new file `toots/hello-world.toot` with the content + +``` +Hello, world! +``` + +You can use subfolders, e.g. `toots/2020-11/hello-world.toot`, as long as the file is in the `toots/` folder and has the `.toot` file extension + +## Create a toot with a poll + +A toot including a poll must end with 2-4 options in the following format + +``` +Here is some text + +[ ] option A +[ ] option B +[ ] option C +[ ] option D +``` + +## Notes + +- Only newly created files are handled, deletions, updates or renames are ignored. +- Toots posted from other Mastodon clients will not be imported as `*.toot` files. +- If you need to rename an existing toot file, please do so locally using [`git mv old_filename new_filename`](https://help.github.com/en/articles/renaming-a-file-using-the-command-line), otherwise it may occur as deleted and added which would trigger a new toot. +- Your message must fit into a single toot (typically 500 characters). + +## Questions? + +If you have any further questions or suggestions, please create an issue at https://github.com/joschi/toot-together/issues/new