added README

1 files changed, 48 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..8af5ae8
--- /dev/null
+++ b/README
@@ -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`)