aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorErik Liodden <[email protected]>2017-07-13 01:05:31 +0200
committerErik Liodden <[email protected]>2017-07-13 01:05:31 +0200
commitd3cf941be12d00faf445a48eeba138e353ffbb11 (patch)
treefd2a32708383418aefc1ff1f7ceb6f8c0657741d
downloadbinary-chopper-d3cf941be12d00faf445a48eeba138e353ffbb11.tar.gz
initial commit
Add README with description of the project, BinaryChopper.
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..2bcd9e8
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+BinaryChopper
+=============
+
+This program takes any file, cut it up into smaller pieces and then merges those
+pieces back again into the original file at some later time. Usefull for sending
+large email attatchments or transfering large files over multiple smaller
+storage units.
+
+Build with `make` from the top directory.
+
+Examples:
+To cut a file into 4 pieces, execute:
+ ./prog --cut 4 --file example.file
+
+To merge those files againg, simply execute (from within the directory of the
+data<num>.bin files):
+ ./prog --merge
+
+
+Erik Liodden