Open importantchoice opened 6 years ago
We need to add some sections to the documentation:
Why we wrote this tool, why should our program be used, analysis of existing tools...
Use case of our tool
Document create_testfs.sh including testfs filestructure (the reason/test case for each file/directory)
create_testfs.sh
Limitations of our program (e.g. linux only)
Evaluation of our program and hiding techniques
Extended usage, e.g. use pipes to add checksumming and encryption
Metadata: explicitly mention that it is serialized as json
Filesystem data structures for ntfs and ext4
Hiding Technique documentation (nearly all)
List all implemented hiding techiques in README.md AND doc/source/01_getting_started.rst
Api Reference for nearly all important modules
Development: move notes from readme to documentation and extend it
Future work (-> turn following bullet points into continuous text!)
-c
Extend "abstract"
include documentation structure (01_overview.rst)
Turn most bullet points into text
Make sphinx size included images to a format that fits on page for the pdf version.
For all:
I don't think the abstract was extended in case to be a real abstract.
We need to add some sections to the documentation:
Why we wrote this tool, why should our program be used, analysis of existing tools...Use case of our toolMaybe just describing a brief scenario where one could use this toolMention that no encryption is applied to the hidden data, so the user is responsible for that.Documentcreate_testfs.sh
including testfs filestructure (the reason/test case for each file/directory)Limitations of our program (e.g. linux only)Evaluation of our program and hiding techniques
Extended usage, e.g. use pipes to add checksumming and encryptionMetadata: explicitly mention that it is serialized as jsonFilesystem data structures for ntfs
and ext4Hiding Technique documentation (nearly all)
List all implemented hiding techiques in README.md AND doc/source/01_getting_started.rstApi Reference for nearly all important modules
Development: move notes from readme to documentation and extend itFuture work (-> turn following bullet points into continuous text!)Use a more secure clearing technique for hiding techniques-c
optionAdd possibility to hide multiple filesImplement a fuse filesystem, which uses multiple hiding techniques to store dataMaybe add encryption featureHide Metadata files itselfmore reliable filesystem autodetection (FAT and NTFS detection only check for an ASCII string in bootsector)Extend "abstract"
include documentation structure (01_overview.rst)Turn most bullet points into text
Make sphinx size included images to a format that fits on page for the pdf version.For all:
onetwo.Add your name to the author variable in fishy/doc/source/conf.py (if you want), so that it will appear on the documentation.