# README

**NOTE**: This project is deprecated in favor of the new
[journal-tools](https://oper.io/src/nullspoon/journal-tools.git) project.
`journal-tools` is almost fully backwards compatible (the template env var is
no longer supported) with `dailyjournal`, so switching is easy.

Dailyjournal is a simple application to quickly open notes for the activities
of each day. The journal entries are automatically named so they are consistent
and predictable. If dailyjournal is run and no entry for the day exists, one is
created from the journal template file; if an entry does exist for today, it is
reopened for editing.

## Setup

To get set up, you will need to copy the journal entry template file from
`/usr/share/dailyjournal/template.md` to
`~/Documents/dailyjournal/.template.md` (unless you have overridden the default
path with the environment variables listed below or unless you want to write
your own template from scratch). Update this template file as needed and then
run `dailyjournal` to start writing!

## Usage

```
dailyjournal [+/-<days>]
```

For the most simple usage, type `dailyjournal` to open today's journal.

To open yesterday's entry, type `dailyjournal -1`, and to open two days ago
type `dailyjournal -2`, etc.

Note that when using negative numbers, dailyjournal does not calculate days,
rather entries. In other words, `-1` is not one day ago, but one entry ago.
This is to make it easier to open previous entries without needing to know how
many days back they are.

For example, if it is Monday and you want to open Friday's entry, and no
entries were made over the weekend, type `dailyjournal -1` and Friday's entry
will be opened (1 entry back). Continuing in this scenario, if an entry exists
on Thursday, typing `dailyjournal -2` on Monday will open Thursday's entry
(again, assuming no weekend entries are present). Friday is one back, Thursday
is two back, Wednesday is three back, etc.

## Environment variables

* **DAILYJOURNAL_DIR**: Path within which to store daily entries (Default:
  `~/Documents/dailyjournal`)
* **DAILYJOURNAL_TEMPLATE**: Path to the daily journal template file which is
  copied into place on new entry creation. (Default:
  `DAILYJOURNAL_DIR/.template.md`)