From 9fa8a83dba7c91c86509142ba9b2c4f2677b181c Mon Sep 17 00:00:00 2001 From: stcb <21@stcb.cc> Date: Tue, 10 Dec 2024 21:34:12 +0200 Subject: [PATCH] Add User Manual starter --- docs/Automats.md | 0 docs/UserManual.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 docs/Automats.md create mode 100644 docs/UserManual.md diff --git a/docs/Automats.md b/docs/Automats.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/UserManual.md b/docs/UserManual.md new file mode 100644 index 0000000..60897c0 --- /dev/null +++ b/docs/UserManual.md @@ -0,0 +1,71 @@ + +# User Manual + + +**Utilization documentation.** + +Written with chapters for the average Joe user, security experts, and developers. + +The average-user section is only about what the average-user will know from Icing: its dialer reference implementation. + +The security expert section will cover all the theory behind our reference implementation, and the Icing protocol. This section can serve as an introduction / transition for the next section: + +The developer section will explain our code architecture and concepts, going in-depth inside the reference implementation and the Icing protocol library. +This library will have dedicated documentation in this section, so any developer can implement it in any desired way. + +Lastly, as a continuation of the developer section, the Manual Test section will cover our manual testing policy. + +--- + + + +## Summary + + + +- [Average User](#averageuser) + +- [Security Expert](#icingsstrategy) + +- [Developer](#developer) + +- [Manual Tests](#manualtests) + + + +--- + + + +## Average User + + +Use the Icing dialer like your normal dialer, if you can't do that we can't help, you dumb retard lmfao. + + + +--- + + + +## Security Expert + + SecUriTy eXpeRt + +--- + + + +## Developer + +int main; + + --- + +## Manual Tests + +1. Call grandpa +2. Receive mum call +3. Order 150g of 95% pure Bolivian coke without encryption +4. Order again but with encryption +5. Compare results