commit 88ff5ba1ec4dbb542b0ab7902ac5202a6387ad0c
parent 95f95742fc5847223959022b7741d410729868b7
Author: mbjd <vir.ingens@gmail.com>
Date: Sat, 19 Nov 2016 15:45:02 +0100
Updated README
- Documented makefile installation rule
- Documented DIARY_DIR environment variable
Diffstat:
| M | README.md | | | 33 | ++++++++++++++++++++++----------- |
1 file changed, 22 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
@@ -12,28 +12,39 @@ This is a text based diary, inspired by [khal](https://github.com/pimutils/khal)
2. Compile (requires ncurses):
```
- make clean; make;
+ make
```
-3. Run the diary with the folder for the text files as first argument:
+3. Install the binary (optional):
```
- ./diary ~/.diary
+ sudo make install
```
- The text files in this folder will be named 'yyyy-mm-dd'.
+ This will copy the binary to /usr/local/bin. To use a different path,
+ change the `INSTALL_DIR` variable in the makefile. You can undo this
+ with `sudo make uninstall`.
- (Optionally create an alias for convencience: `alias diary="~/.bin/diary ~/.diary")`
+4. Run the diary with the folder for the text files as first argument:
+ ```
+ diary ~/.diary
+ ```
+
+ Instead of this, you can also set the environment variable `DIARY_DIR`
+ to the desired directory. If both an argument and the environment
+ variable are given, the argument takes precedence.
+
+ The text files in this folder will be named 'yyyy-mm-dd'.
-4. Use the keypad or VIM-like shortcuts to move between dates:
+5. Use the keypad or VIM-like shortcuts to move between dates:
```
e, Enter Edit the current entry
- t, Jump to today
+ t Jump to today
- j go forward by 1 week
- k go backward by 1 week
- h go left by 1 day
- l go right by 1 day
+ j, down go forward by 1 week
+ k, up go backward by 1 week
+ h, left go left by 1 day
+ l, right go right by 1 day
g go to the first date
G go to the last date
