Skip to content

Commit 7fa2f94

Browse files
committed
Add more detail to config in README
1 parent 4ff6a8c commit 7fa2f94

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,7 @@ curl https://cdn.rawgit.com/pimterry/notes/v0.1.2/notes > /usr/local/bin/notes &
2929

3030
By default your notes live in ~/notes, but you can change that to anywhere you like by setting the `$NOTES_DIRECTORY` environmental variable.
3131

32-
## How do I configure this?
33-
34-
You can set the configuration by creating a file at "~/.config/notes/config". We've included an example for you (config.example) that you can copy.
35-
36-
### Bash completion
32+
#### Installing Bash completion
3733

3834
If you want bash autocompletion copy the completion script into the bash completion directory. The bash completion directory is `/usr/share/bash-completion/completions/` on a typical debian jessie install, you can you can get the bash completion directory by running the following command:
3935

@@ -45,6 +41,14 @@ Installing the completions might be as follows:
4541
curl https://cdn.rawgit.com/pimterry/notes/v0.1.1/notes.bash_completion > /usr/share/bash-completion/completions/notes
4642
```
4743

44+
## How do I configure this?
45+
46+
You can set your favourite text editor and your notes directory by setting the `$EDITOR` and `$NOTES_DIRECTORY` environmental variables.
47+
48+
Most users shouldn't need to do any more than that. If you're doing anything more complicated though, you can configure `notes` config directly in "~/.config/notes/config", including EDITOR and NOTES_DIRECTORY. We've included an example in this repo for you ([config.example](config.example)) that you can copy. Any values set in the config file override values in environment variables.
49+
50+
Right now this mainly exists in case you want to use a different `EDITOR` for notes than the one you have set in your environment generally, but this is where all other config will be living in future.
51+
4852
## How do I use it?
4953

5054
### `notes new <note-name>`

0 commit comments

Comments
 (0)