semtle / terminal_velocity

A fast note-taking app for the UNIX terminal

Terminal Velocity

Terminal Velocity is a fast note-taking app for the UNIX terminal, that focuses on letting you create or find a note as quickly and easily as possible, then uses your $EDITOR to open and edit the note. It is heavily inspired by the OS X app Notational Velocity. For screenshots and features, see the Terminal Velocity website.

To install Terminal Velocity, run:

pip install terminal_velocity

Then to launch it just run:

terminal_velocity

To use a different notes directory, run:

terminal_velocity path/to/your/notes/dir

To see all the command-line options, run:

terminal_velocity -h

To quit the app, press ctrl-c or ctrl-x.

To upgrade Terminal Velocity to the latest version, run:

pip install --upgrade terminal_velocity

To uninstall it, run:

pip uninstall terminal_velocity

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.

Hacking

To release a new version of Terminal Velocity:

1. 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.
2. 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/.