From 3315af27ff4b4059be589e37aa7a49079d3a9573 Mon Sep 17 00:00:00 2001 From: Siddharth Ravikumar Date: Thu, 6 Nov 2014 08:16:06 -0500 Subject: added README --- README | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..8af5ae8 --- /dev/null +++ b/README @@ -0,0 +1,48 @@ + + +# 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 (`gpg id: 0x00B252AF`) -- cgit v1.2.3