README

VITABS
======

Project website (with screenshots): <http://pstiasny.github.io/VITABS/>


Introduction
------------
VITABS is a guitar tab editor inspired by the legendary Vi text editor.  It is
created with convenient editing and fast keyboard entry in mind.  Keyboard
mappings are modeled after Vi and Vim.

A more detailed documentation is available in the doc directory in Markdown
format.


Requirements
------------
Python 3 and curses library are required to run VITABS.
python-rtmidi is required for MIDI playback.


Installation
------------
It's easiest to get VITABS via the pip package manager::

    pip install vitabs[midi]


Features
--------
* Vi-like editing commands
* MIDI playback

Planned features include multiple tracks and plugin support.


License and Disclaimer
----------------------
Copyright (C) 2011  Paweł Stiasny

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.


Contact
-------
pawelstiasny [at] gmail . com