wlinator/tux
1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
Code Issues Releases Wiki Activity

docs(README.md, development.md): update file references from .json to .yml to reflect changes in configuration file format

Browse source 
fix(development.md): correct .env.example to .env to accurately represent the environment file name
This commit is contained in:
kzndotsh 2024-08-22 01:45:57 +00:00
parent c3bb4443df
commit 66fc66247c
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -110,10 +110,10 @@ Further detailed instructions can be found in the [development guide](docs/devel
We offer dev tokens on request in our Discord server.
7. Copy the `config/settings.json.example` file to `config/settings.json` and fill in the required values.
7. Copy the `config/settings.yml.example` file to `config/settings.yml` and fill in the required values.
```bash
cp config/settings.json.example config/settings.json
cp config/settings.yml.example config/settings.yml
```
Be sure to add your Discord user ID to the `BOT_OWNER` key in the settings file.

4
docs/development.md
View file

@ -50,9 +50,9 @@ The project is structured as follows:
### Configuration
- `.env.example`: The example environment file containing the environment variables required for the bot.
- `.env`: The environment file containing the secret environment variables for the bot.
- `config/`: The config directory containing the configuration files for the bot.
- `settings.json`: The settings file containing the bot settings and configuration.
- `settings.yml`: The settings file containing the bot settings and configuration.
### Documentation