diff options
author | Siddharth Ravikumar <sravik@bgsu.edu> | 2014-11-06 08:16:06 -0500 |
---|---|---|
committer | Siddharth Ravikumar <sravik@bgsu.edu> | 2014-11-06 08:16:06 -0500 |
commit | 3315af27ff4b4059be589e37aa7a49079d3a9573 (patch) | |
tree | 9557069c0408cb0cf30206275bf626125ec406ab /README | |
parent | 32a6631412d4289f72ee41a13850bb95c9320f4a (diff) |
added README
Diffstat (limited to 'README')
-rw-r--r-- | README | 48 |
1 files changed, 48 insertions, 0 deletions
@@ -0,0 +1,48 @@ +<!-- -*- mode: markdown; -*- --> + +# combox + +Splits and encrypts files and scatters them to directories which slurp +files into surveillance nodes like Google Docs, Dropbox, etc. + +The ideas for this program is based on [`combobox`][1]. + +[1]: https://bitbucket.org/bgsucodeloverslab/combobox + +# status + +Core functionility is being written at the moment. + +# requirments + +* Python v2.7 +* PyYAML v3.x + +# platform + +At the moment `combox` is written and tested on a GNU/Linux based +operating system. + +# running tests + +All the tests are at `combox/tests`. To run a test file, do: + + $ cd combox + $ python -m tests.test_name + +For instance, to run `combox/tests/test_crypto.py`, do: + + $ cd combox + $ python -m tests.test_crypto + +The success of the tests must be manually verified, so please read the +test file before you run them. + +# license + +`combox` is licensed under the GNU General Public License version 3 or +later. See COPYING. + +# contact + +Siddharth Ravikumar <sravik@bgsu.edu> (`gpg id: 0x00B252AF`) |