further doc cleanup
This commit is contained in:
27
README.md
27
README.md
@@ -27,28 +27,21 @@ but instead could use the tools already provided by the operating system.
|
|||||||
-p | --print : Print note to console
|
-p | --print : Print note to console
|
||||||
|
|
||||||
## Installing
|
## Installing
|
||||||
### Notice:
|
### Dependencies
|
||||||
To migrate from SNS, simply move
|
* vim
|
||||||
$HOME/.local/sns to $HOME/.config/vns,
|
* gpg2
|
||||||
then append ".gpg" to each note name, for example
|
* tree
|
||||||
`find "$HOME/.local/vns" -type f -exec mv {} {}.gpg \;`
|
* git
|
||||||
|
|
||||||
To install, place `vns` in your path,
|
|
||||||
|
|
||||||
** Note: ** Install [vim-gnupg] before use. vns *does* check this, but only *after*
|
** Note: ** Install [vim-gnupg] before use. vns *does* check this, but only *after*
|
||||||
the first note has been created.
|
a note has been created.
|
||||||
|
|
||||||
To uninstall, remove the files you copied. Notes will still exist in $HOME/.config/vns
|
To install, place `vns` in your path, and run `vns -i`.
|
||||||
|
|
||||||
Once installed, vns will require you to run `vns -i`, to indicate you would like
|
vim note system will establish its note store under ~/.config/vns.
|
||||||
to create its note store and write its default configuration.
|
The location of the store may be changed on line 6.
|
||||||
|
|
||||||
By default, vns will set itself up in `~/.config/vns`
|
To uninstall, remove the files you copied. Notes will still exist in ~/.config/vns
|
||||||
This behaviour is defined on line 6.
|
|
||||||
|
|
||||||
|
|
||||||
**A word about encryption:**
|
|
||||||
Encryption is handled by the vim-gnupg plugin.
|
|
||||||
|
|
||||||
## Tips and Tricks
|
## Tips and Tricks
|
||||||
* To list all notes in all notebooks, simply run `vns`.
|
* To list all notes in all notebooks, simply run `vns`.
|
||||||
|
|||||||
Reference in New Issue
Block a user