diff options
| author | Florian Fischer <florian.fl.fischer@fau.de> | 2017-03-16 22:14:19 +0100 |
|---|---|---|
| committer | Florian Fischer <florian.fl.fischer@fau.de> | 2017-03-16 22:14:19 +0100 |
| commit | ad5397198e7e6582a394ff2deb1e8e11725f4153 (patch) | |
| tree | 3a486e9370ad09bb02a5c14eb0d9c99718a11a81 | |
| parent | 01a4df472ea2a97d90f2c90772699a3662dda9b4 (diff) | |
| download | diary-ad5397198e7e6582a394ff2deb1e8e11725f4153.tar.gz diary-ad5397198e7e6582a394ff2deb1e8e11725f4153.zip | |
improve README
| -rw-r--r-- | Readme.md | 23 |
1 files changed, 20 insertions, 3 deletions
@@ -1,8 +1,25 @@ # Diary - Personal diary +## Installation + +Clone the repo with: +`clone https:/muhq.space/software/diary.git` +And copy `diary` into your path. + +## Usage + + diary [date] opens the diary entry from date or today if date is not provided. + + ## Configuration -diary reads files at: +Diary reads the configuration from: + +1. `$XDG_CONFIG/diary/config` or `$HOME/.config/diary/config` +2. `$HOME/.diaryrc` + +Config values: + +1. diary_location - The path to the directory, in which the diary is stored +2. gpg_id - The id of the pgp public key for encryption -1. $XDG_CONFIG/diary/config -2. $HOME/.diaryrc |