histd/readme.md

# How I spent this day

A simple but useful personal diary application.

The sole purpose of this application is to quickly create a file
and open it in a text editor so that I can take a note before I lose my desire.
Notes can be found in the `~/.local/share/histd` directory.

```sh
tree ~/.local/share/histd
# /home/user/.local/share/histd
# └── 2022
#     └── 08
#         ├── 18.md
#         └── 19.md
```

## Usage
Make sure the `EDITOR` environment variable is set
to the name of your favorite text editor.

If it's not, edit the `~/.bashrc` file (or `~/.zshrc`)
```bash
export EDITOR=nano
```

Then mark this script as executable:
```bash
chmod +x histd.sh
```

Now you can create your first note:
```bash
./histd.sh
```

## Backup
To create an archive of all notes, run the following command:
```bash
./histd.sh backup
```
Required programs: `tar`, `xz`.

## Merge all notes
This command concatenates all files and prefixes each with the filename.
```bash
./histd.sh merge
```

## List all notes
```bash
./histd.sh list
# /home/user/.local/share/histd
# └── 2022
#     └── 08
#         ├── 18.md
#         └── 19.md
```
Required programs: `tree`