From 45d9b76d8ceb4cb45384084889d279147e993ff1 Mon Sep 17 00:00:00 2001 From: Siddharth Ravikumar Date: Wed, 14 Jan 2015 09:08:00 -0500 Subject: renamed: README -> README.md --- README | 61 ------------------------------------------------------------- 1 file changed, 61 deletions(-) delete mode 100644 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index 98378ca..0000000 --- a/README +++ /dev/null @@ -1,61 +0,0 @@ - - -# combox - -Splits and encrypts files and scatters them to directories from which -files are slurped into surveillance nodes like Google Docs, Dropbox, -etc. - -The ideas for this program is based on [`combobox`][1]. - -[1]: https://bitbucket.org/bgsucodeloverslab/combobox - -# etymology - -`combox` is a lazy contraction of the word "combo box". `combox` is -pronounced as "combo box". - -# status - -Core functionality is being written at the moment. - -# requirements - -* virtualenv v1.9.x or later -* python v2.7.x -* PyYAML v3.x -* nose v1.3.x -* watchdog v0.8.2 -* pycrypto v2.6.1 - -# platform - -At the moment `combox` is written and tested on a GNU/Linux based -operating system. - -# setting up the environment - -From the same directory as this README file, do: - - $ virtualenv . - -Activate the virtual environment: - - $ source bin/activate - -Install dependencies by simply installing combox: - - $ python setup.py install - -# running tests - - $ nosetests - -# license - -`combox` is licensed under the GNU General Public License version 3 or -later. See COPYING. - -# contact - -siddharth ravikumar (`gpg id: 0x00B252AF`) -- cgit v1.2.3