1 # README
2
3 Dailyjournal is a simple application to quickly open notes for the activities
4 of each day. The journal entries are automatically named so they are consistent
5 and predictable. If dailyjournal is run and no entry for the day exists, one is
6 created from the journal template file; if an entry does exist for today, it is
7 reopened for editing.
8
9 ## Setup
10
11 To get set up, you will need to copy the journal entry template file from
12 `/usr/share/dailyjournal/template.md` to
13 `~/Documents/dailyjournal/.template.md` (unless you have overridden the default
14 path with the environment variables listed below or unless you want to write
15 your own template from scratch). Update this template file as needed and then
16 run `dailyjournal` to start writing!
17
18 ## Usage
19
20 ```
21 dailyjournal [+/-<days>]
22 ```
23
24 For the most simple usage, type `dailyjournal` to open today's journal.
25
26 To open yesterday's entry, type `dailyjournal -1`, and to open two days ago
27 type `dailyjournal -2`, etc.
28
29 Note that when using negative numbers, dailyjournal does not calculate days,
30 rather entries. In other words, `-1` is not one day ago, but one entry ago.
31 This is to make it easier to open previous entries without needing to know how
32 many days back they are.
33
34 For example, if it is Monday and you want to open Friday's entry, and no
35 entries were made over the weekend, type `dailyjournal -1` and Friday's entry
36 will be opened (1 entry back). Continuing in this scenario, if an entry exists
37 on Thursday, typing `dailyjournal -2` on Monday will open Thursday's entry
38 (again, assuming no weekend entries are present). Friday is one back, Thursday
39 is two back, Wednesday is three back, etc.
40
41 ## Environment variables
42
43 * **DAILYJOURNAL_DIR**: Path within which to store daily entries (Default:
44 `~/Documents/dailyjournal`)
45 * **DAILYJOURNAL_TEMPLATE**: Path to the daily journal template file which is
46 copied into place on new entry creation. (Default:
47 `DAILYJOURNAL_DIR/.template.md`)
|
