Merge (#18) from tomasriveral/readme-configuration

fix: default configuration 
replace ~/Documents/Notes to ~/Documents which should exist in most systems
This commit is contained in:
2026-04-27 19:29:36 +02:00
committed by GitHub
2 changed files with 6 additions and 3 deletions
+2 -1
View File
@@ -78,7 +78,7 @@ nix-build
make
```
5. Configure `./config.json` (it is automatically created on first launch if it does not already exist).
5. [Configure](#configuration) `~/.config/notewrapper/config.json` (it is automatically created on first launch if it does not already exist).
6. Run the program:
```shell
@@ -199,6 +199,7 @@ Edit `~/.config/notewrapper/config.json`. If it does not exist, it will be creat
Note:
* Directories must end with `/`.
* All directories used must exist.
* Elements of `directory` and `backup.directory` must match exactly.
* Directories set in `directory` but not in `backup.directory` won't be backed up.
* Directories set in `backup.directory` but not in `directory` will be ignored.
+4 -2
View File
@@ -145,7 +145,7 @@ void initAppFilesAndDirs(const char *home, const int shouldDebug) {
error(!w, "program", "fopen failed opening %s");
fprintf(w, //TODO CHANGE default json
"{\n"
" \"directory\": [\"~/Documents/Notes/\"],\n"
" \"directory\": [\"~/Documents/\"],\n"// I personally use ~/Documents/Notes. But the dir doesn't exist most times. So for the default user it is better to put ~/Documents
" \"render\": true,\n"
" \"jumpToEndOfFileOnLaunch\": true,\n"
" \"editor\": \"neovim\",\n"
@@ -154,7 +154,9 @@ void initAppFilesAndDirs(const char *home, const int shouldDebug) {
" \"newLineOnOpening\": true,\n"
" \"backup\": {\n"
" \"enable\": false,\n"
" \"directory\": \"/path/to/backup\",\n"
" \"directory\": {\n"
" \"~/Documents/\": \"path/to/backup/\"\n"
" },\n"
" \"interval\": \"weekly\",\n"
" \"rsyncArgs\": [\"-Lqah\", \"--update\"]\n"
" }\n"