notebook

A command-line note-keeping app that uses Git for backups.

ALL RIGHTS RESERVED, unless otherwise noted.

Install:

Instructions (for Unix/Posix/Linux/MacOS systems):

1. Clone this repository. Run setup program.

   git clone [email protected]:HalCanary/notebook.git
   notebook/setup
   

2. Make sure ~/bin is in your PATH environemnt variable.

3. Make sure that the VISUAL environemnt variable is set to the path of your favorite text editor.

4. Make a place to securely push your repository to, then set that as remote

   cd .../notebook
   git remote add origin YOUR_REPOSITORY_URL
   

Make a note:

Just execute the following from the command line:

note

This will edit a file in the notebook/YYYY/MM/ directory (creating the directory if needed) called notes-YYYY-mm-dd_Www.txt. For example: notebook/2022/11/notes-2022-11-11_Fri.txt.

Backup notes to your secure backup:

Just execute the following from the command line:

notebook-update

This will create a commit of any changes to the notebook directory.