Mastodon
/
ephemetoot-eliminare-vecchi-messaggi
mirror of https://github.com/hughrun/ephemetoot
1
0
Fork 0
Code Issues Releases Wiki Activity

clarify --init filepaths in docs

This commit is contained in:
Hugh Rundle 2021-05-25 08:27:49 +10:00
parent 2c50e89192
commit 7e330b919f
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/install.md
View File

@ -43,7 +43,7 @@ Now you've installed `ephemetoot`, in order to actually use it you will need an
## Configuration file
Configuration for each user is set up in the `config.yaml` file. This uses [yaml syntax](https://yaml.org/spec/1.2/spec.html) and can be updated at any time without having to reload `ephemetoot`.
By default, configuration for each user is expected to be in a file called `config.yaml` in the path from where `ephemetoot` is run. This uses [yaml syntax](https://yaml.org/spec/1.2/spec.html) and can be updated at any time without having to reload/restart `ephemetoot`.
You can create a config file by hand, but the easiest way to do it is with the `--init` flag:
@ -51,7 +51,9 @@ You can create a config file by hand, but the easiest way to do it is with the `
ephemetoot --init
```
This will ask you to fill in information for each part of the file:
Calling `--init` will save your configuration file as `config.yaml` in the current directory. Once this file has been created, you may change the name or move the file if you prefer. See [`--config`](./options.html#specify-the-config-location-config) for more detail on using a non-default configuration filepath.
`--init` will ask you to fill in information for each part of the file:
| setting | description |
| ---: | :--- |

4
docs/options.md
View File

@ -6,13 +6,13 @@ It is **strongly recommended** that you do a test run before using `ephemetoot`
## Create your config file (--init)
Before you can use `ephemetoot` you need a `config.yaml` file. You can create this yourself, but `--init` will walk you through the values you need and save your `config.yaml` file in the directory from which you run the command:
Before you can use `ephemetoot` you need a configuration file. You can create this yourself, but `--init` will walk you through the values you need and save it to `config.yaml` in the directory from which you run the command:
```shell
ephemetoot --init
```
More information about the config file can be found on teh _[Installation](./install.md)_ page, and an [example file](https://github.com/hughrun/ephemetoot/blob/master/example-config.yaml) is available on GitHub.
More information about the config file can be found on the _[Installation](./install.md#configuration-file)_ page, and an [example file](https://github.com/hughrun/ephemetoot/blob/master/example-config.yaml) is available on GitHub.
## Run in test mode (--test)