Installation

pip install terminal-velocity-git

terminal_velocity
terminal-velocity

terminal_velocity path/to/your/notes/dir

terminal_velocity -h

pip install --upgrade terminal_velocity

pip uninstall terminal_velocity

apt install python-setuptools python-chardet python-urwid python-dev

git@github.com:vhp/terminal_velocity.git
or
https://github.com/vhp/terminal_velocity.git

sudo python setup.py install

Sync your notes to Git

You will need:

• A GitHub or GitLab project (for free private projects GitLab is recommended)

• The clone URL of the git project

Before setting this up !!take a backup of your existing Notes directory!!.

Create file ~/.git_notes_project.yaml, and add the following:

project url: <git-project-url>

Optionally you can change the directory that terminal-velocity uses for notes by adding the following to the file:

project directory: ~/My-Other-Notes-Directory

Note that this configuration does not affect the terminal velocity configuration, only the Git project management add-on.

When you start terminal-velocity it will automatically initialise the Git project within your Notes directory

Releasing to PyPi

To release a new version of Terminal Velocity:

1. Make sure you have setup your ~/.pypirc file for PyPi uploading

2. Increment the version number in the setup.py file, add an entry te the changelog, commit both changes to git and push them to github. For example, see aae87b.

3. Upload the new release to the terminal_velocity package on pypi: run python setup.py sdist upload -r pypi.

For more information see https://packaging.python.org/.

Other things

To make a bug report or feature request, use GitHub Issues.

To contribute documentation, use the wiki.

To contribute code to Terminal Velocity, see CONTRIBUTING.