Open and edit notes for the current or given git branch.

Work on a task branch and open notes for it simply by calling `branch-notes`.

By default a notes file is created as `NOTES_DIR/<toplevel>/<branch>.txt`, with
 - `NOTES_DIR` being read from the environment variable of the same name
 - `toplevel` being the name of the root directory of the git repository
 - `branch` being the name of the git branch


## Requirements

- Python 3


## Installation

```
cd /usr/local/bin
ln -s /path/to/repo/branch_notes.py branch-notes
```


## Usage

`branch-notes open` to open the notes file for the current git repository and branch

`branch-notes list` to list all existing notes

`branch-notes --help` to show all available options

Open and edit notes for the current or given git branch.

Work on a task branch and open notes for it simply by calling `branch-notes`.

By default a notes file is created as `NOTES_DIR/<toplevel>/<branch>.txt`, with
 - `NOTES_DIR` being read from the environment variable of the same name
 - `toplevel` being the name of the root directory of the git repository
 - `branch` being the name of the git branch


## Requirements

- Python 3


## Installation

**On OSX:**

```
cd /usr/local/bin
ln -s /path/to/repo/branch_notes.py branch-notes

# To install the bash autocompletion:
cd /usr/local/etc/bash_completion.d
ln -s /path/to/repo/branch_notes.bash-completion .
```

**On Linux:**

Same as OSX but use `/usr/bin/` and `/etc/bash_completion.d` instead.


## Usage

`branch-notes open` to open the notes file for the current git repository and branch

`branch-notes list` to list all existing notes

`branch-notes --help` to show all available options

Update and clarify installation instructions.
Update and clarify installation instructions.

Linux uses a different directory structure than OSX and installing the
bash autocompletion is not necessarily obvious either.
