aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 68eeec55b0930dca9b621a4030c32991c3ab1b01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
auditory.vim
============

Interface sounds for vim. Sounds are played on various basic commands. In insert mode, a random note in a scale are played on each keypress.

Created at Music Hack Day Boston 2014.


**Note:** this is alpha software is still very buggy. Some mappings don't support counts when they should. A few audio files are available but the mappings haven't yet been implemented.


## Requirements
Requires [mplayer](http://www.mplayerhq.hu/).


## Installation
The plugin can be installed using any of the various Vim plugin managers. If you use [pathogen](https://github.com/tpope/vim-pathogen), you can run the following to install:

	cd ~/.vim/bundle
	git clone https://github.com/teddywing/auditory.vim.git


## Contributing
The code is a bit hackish at the moment. Any help improving the plugin is very much appreciated. Check the TODO file for ideas.


## Contributors
- [Spencer Bateman](https://soundcloud.com/spencerbateman)
- [Mackenzie Denker](https://soundcloud.com/mackenzie-denker)


## License
Licensed under the MIT license. See the included LICENSE file.