Commit: 9bdcb0404e6ee7e38136a3d3ba8484ac8ac2ec73
Parent: 90af7fa37b87236d81c97dbc1e29544862dedeee
Author: Ren Tatsumoto
Date: Tue, 3 Aug 2021 18:28:22 +0300
mention profiles in the readme
Diffstat:
M | README.md | | | 34 | ++++++++++++++++++++++++++++++++++ |
1 file changed, 34 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -379,6 +379,40 @@ X sub-step 1
x sub-step -1
```
+## Profiles
+
+Mpvacious supports config profiles.
+To make use of them, create a new config file called `subs2srs_profiles.conf`
+in the same folder as your [subs2srs.conf](#Configuration).
+Inside the file, define available profile names (without `.conf`) and the name of the active profile:
+
+```
+profiles=subs2srs,english,german
+active=subs2srs
+```
+
+In the example above, I have three profiles.
+The first one is the default,
+the second one is for learning English,
+the third one is for learning German.
+
+Then in the same folder create config files for each of the defined profiles.
+For example, below is the contents of my `english.conf` file:
+
+```
+deck_name=English sentence mining
+model_name=General
+sentence_field=Question
+audio_field=Audio
+image_field=Extra
+```
+
+You don't have to redefine all settings in the new profile.
+Specify only the ones you want be different from the default.
+
+To cycle profiles, open the advanced menu by pressing `a` and then press `p`.
+At any time you can see what profile is active in the menu's status bar.
+
## Hacking
If you want to modify this script