~sotirisp/today

a4f48bdfb6b7fb53ebfabecb1609cddff02584f3 — Sotiris Papatheodorou 10 months ago ebcb024 v2.0.1
Update the README
1 files changed, 6 insertions(+), 12 deletions(-)

M README.md
M README.md => README.md +6 -12
@@ 13,23 13,18 @@ motivation was to create an easy to use daily work journal.

`today` creates a journal file `YYYYMMDD.md` named with the current date. The
file is opened with `$VISUAL` or `$EDITOR` if the former is not defined. The
journal files are stored in the first directory that exists among the
following:

``` bash
$TODAY_DIR
$XDG_DATA_HOME/today
$HOME/.local/share/today
```
journal files are stored in the first directory that exists among `$TODAY_DIR`,
`$XDG_DATA_HOME/today` and `$HOME/.local/share/today`.

The `today` repository contains symbolic links to `today` under various names
which act as shortcuts for common tasks.

``` bash
``` sh
today     # Edit today's journal
yesterday # Edit yesterday's journal
tomorrow  # Edit tomorrow's journal
prevday   # Edit the most recent journal excluding today's journal
nextday   # Edit the closest future journal
week      # Pretty print this week's journals
prevweek  # Pretty print the previous week's journals
nextweek  # Pretty print the next week's journals


@@ 44,10 39,9 @@ See the `today` manpage for more detailed information.

## Installation

Create the symbolic links and install the script along with the manpage:
To install the script and its manpage:

``` bash
make
``` sh
sudo make install
```