Readme: add more info about the initial setup and required programs

This commit is contained in:
Ivan R. 2023-02-16 23:54:15 +05:00
parent 5417f28b15
commit 73a7085dae
No known key found for this signature in database
GPG key ID: 56C7BAAE859B302C

View file

@ -16,8 +16,21 @@ tree ~/.local/share/histd
```
## 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
```
@ -26,9 +39,21 @@ 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`