commit 9aada882f5a7cc8c268adcef42ca4963d5f66850 parent f2538673a4daef18793e98bb4f087222f2c23731 Author: in0rdr <andreas.gruhler@uzh.ch> Date: Wed, 16 Nov 2016 23:04:24 +0800 Update README.md Diffstat:
| M | README.md | | | 26 | ++++++++++++++++++++++++-- |
1 file changed, 24 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md @@ -1,2 +1,24 @@ -# diary -Simple CLI diary +# Simple CLI Diary + +This is a text based diary, inspired by [khal](https://github.com/pimutils/khal). Diary entries are stored in raw text. You may say C & ncurses are old, I say paper is older.. + +## Usage +1. Set the EDITOR environment variable to your favourite text editor: + ``` + export EDITOR=vim + ``` + +2. Compile the diary with ncurses library: + ``` + gcc diary.c -o diary -lncurses -std=gnu11 + ``` + +3. Run the diary with the folder for the text files as first argument: + ``` + ./diary ~/.diary + ``` + + The text files in this folder will be named 'yyyy-mm-dd'. + + (Optionally create an alias for convencience: `alias diary="~/.bin/diary ~/.diary")` +