summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormanzerbredes <loic.guegan_secondary@yahoo.fr>2015-03-21 06:53:07 +0100
committermanzerbredes <loic.guegan_secondary@yahoo.fr>2015-03-21 06:53:07 +0100
commit697d44fd357779309bb0c1931f589a92bb88a642 (patch)
tree1dd6e8bc71512110f645ab78c147f23a6b138031
parent576253d42518b319e5418aa46d37da71fcf81bad (diff)
Edit readme
-rw-r--r--src/Readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/Readme.md b/src/Readme.md
index e69de29..6600ef4 100644
--- a/src/Readme.md
+++ b/src/Readme.md
@@ -0,0 +1,21 @@
+Class organisation
+=====
+
+##CryptClass
+> Contain all crypting algorithm, and use
+**crypto++** library.
+
+##IOFileClass
+> Contain all class that manage IO in file.
+*FileManIOFile* class load and save encrypted files, and use
+class from *CryptClass*.
+
+##ParserClass
+> Contain class for parsing data (exemple: parsing a decrypted file from *FileManIOFile*.
+
+##Coming soon:
+>GTK+Class to manager GUI.
+<br /><br />
+
+PLEASE USE DOXYGEN COMMENTS
+===== \ No newline at end of file