From 0502987880cb04079fc78213951d0e7aeda961a2 Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Wed, 20 Apr 2022 18:14:38 +0100 Subject: [PATCH] Update README.md added section toml files. --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 318aeb3..56abb76 100644 --- a/README.md +++ b/README.md @@ -53,9 +53,29 @@ A *kind_id* specifies a major Voicemeeter version. This may be one of: - `banana` - `potato` -## Config Files -The following config files should be placed in the same directory as your `__main__.py`. +## TOML Files +This is how your files should be organised. Wherever your `__main__.py` file is located (after install this can be any location), `config` and `profiles` directories +should be in the same location. +Regarding profiles, a directory for each kind should hold the profile files and in each there can be any number of config files. Example, a config for streaming, a config for general listening/movie watching or any other type of config. +. +├── `__main__.py` +├── configs +        ├── app.toml +        ├── vban.toml +├── profiles +        ├── basic +                ├── example.toml +                ├── other_config.toml +                ├── streaming_config.toml +        ├── banana +                ├── example.toml +                ├── other.toml +                ├── ... +        ├── potato +                ├── example.toml +                ├── ... +## Config Files ### app.toml Configure certain startup states for the app. - `theme`