Skip to content

Commit

Permalink
Docs updated: major updates are coming to Mission Statement.
Browse files Browse the repository at this point in the history
  • Loading branch information
arekbulski committed Dec 17, 2021
1 parent dedb002 commit 8455a82
Show file tree
Hide file tree
Showing 14 changed files with 172 additions and 15 deletions.
3 changes: 2 additions & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The MIT License (MIT)
-------------------------

Copyright (c) 2015 Arkadiusz Bulski
Copyright (c) 2015-2021 Arkadiusz Bulski

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand All @@ -19,3 +19,4 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,23 @@

Cameleonica is a prototype safe cryptographic steganographic advanced filesystem.

Features include confidentiality, authenticity, plausible deniability, permanent deletion, versioning, snapshots, atomicity, transactions, file and directory cloning, internal compression, non-transparent compression and hashing, deduplication, serializability, multiple-device replication and tiering.
Features include integrity, versioning, snapshots, atomicity, transactions, confidentiality, authenticity, permanent deletion, plausible deniability, file and directory cloning, internal compression, integration of compression and hashing, serializability, file-level replication and tiering.

Internal design includes atomic and ordered operations, diskless fsync, copy on write, segmented log-structured disk layout, copying garbage collector, complete inodes, complete dictionary, rings and chains abstract data structures, file-level replication and tiering.
(***) Internal design includes atomic and ordered operations, diskless fsync, copy on write, segmented log-structured disk layout, copying garbage collector, complete inodes, complete dictionary, rings and chains abstract data structures, file-level replication and tiering.

Project status and roadmap
------------------------------

Only design documentation is being developed at this point. You can help by reviewing these documents and posting questions or suggestions for improvement, just create a new Issue. Please do NOT submit Pull Requests, unless recording changes was enabled. It is impossible to diff odt files.
Only design documentation is being developed at this point. You can help by reviewing the combined document and posting questions or suggestions for improvement. Just create a new GitHub Issue.

- [Complete specification pdf](documentation/combined.pdf) (48 pages)
- [Complete specification pdf](documentation/combined.pdf) (46 pages)

Documentation is divided into sections:

- Mission statement (6 pages)
- Ideas and Observations (20 pages)
- Preliminary design (currently edited, 10 pages)
- Python/Fuse implementation plan (currently edited, 6 pages)
- Questions and Answers (4 pages)

Experimental code is also in the repository.
I recommend downloading it and opening in your favorite PDF viewer.

Development notice
----------------------

Code will be developed in Python/FUSE and later possibly in-kernel. Documentation is created in LibreOffice, XMind and [draw.io](https://www.draw.io/). User experience design will be done in Glade.

License is set to MIT Licence, unless something changes.

Binary file added documentation/certificate.odt
Binary file not shown.
Binary file added documentation/certificate.pdf
Binary file not shown.
Binary file modified documentation/combined.odt
Binary file not shown.
Binary file modified documentation/combined.pdf
Binary file not shown.
Binary file modified documentation/cover.odt
Binary file not shown.
Binary file modified documentation/cover.pdf
Binary file not shown.
1 change: 0 additions & 1 deletion documentation/hiddenfiles.xml

This file was deleted.

Binary file removed documentation/hiddenfiles1.png
Binary file not shown.
Binary file removed documentation/hiddenfiles2.png
Binary file not shown.

Large diffs are not rendered by default.

Binary file added documentation/sticker.odt
Binary file not shown.
Binary file added documentation/sticker.pdf
Binary file not shown.

0 comments on commit 8455a82

Please sign in to comment.