diff options
| author | Jeff Zhao <jeff.no.zhao@gmail.com> | 2022-01-01 20:10:08 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-01 20:10:08 -0500 |
| commit | f3a42a66f054879b0450260c63ee3587a955cc78 (patch) | |
| tree | 3f7aa917f75a3a68a8b8add0b0fbd17593d86668 | |
| parent | 7791f93d95d350bdbb8dbdde4a9ec6fcbd32df41 (diff) | |
Update README.md
| -rw-r--r-- | docs/configuration/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/configuration/README.md b/docs/configuration/README.md index e9ec2fb..644ca38 100644 --- a/docs/configuration/README.md +++ b/docs/configuration/README.md @@ -10,3 +10,13 @@ Joshuto can currently be configured using the following files: - [keymap.toml](/docs/configuration/keymap.toml.md): keymapping configurations - [mimetype.toml](/docs/configuration/mimetype.toml.md): mimetype configurations - [theme.toml](/docs/configuration/theme.toml.md): theming configurations + +**Please copy these configs and use it as a base, then modify them accordingly.** + +Joshuto's behavior is: +- If there exists a config file, use that config. (No default or inherited values from a default config) +- If there is no config file, a default config will be used (found under `config/`) + +This means Joshuto will have no themes or no mimetype entries if you have an empty `theme.toml` or `mimetype.toml` file + + |