Update tutorial

hakavlad · Apr 13, 2024 · 871dcaf · 871dcaf
1 parent 52479f5
commit 871dcaf
Show file tree

Hide file tree

Showing 3 changed files with 203 additions and 56 deletions.
diff --git a/docs/tutorial/0.md b/docs/tutorial/0.md
@@ -14,13 +14,13 @@ Select option `0` and press `Enter` to exit the menu.
 $ tird
 
                        MENU
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    0. Exit              1. Show info
+    ———————————————————————————————————————————
+    0. Exit              1. Info
     2. Encrypt           3. Decrypt
     4. Embed             5. Extract
     6. Encrypt & embed   7. Extract & decrypt
     8. Create w/ random  9. Overwrite w/ random
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    ———————————————————————————————————————————
 [01] Select an option [0-9]: 0
 I: action #0: exit
 ```
@@ -29,7 +29,7 @@ I: action #0: exit
 <details>
 <summary>Screenshot</summary>
 
-![Screenshot](https://i.imgur.com/baPCKwA.png)
+![Screenshot](https://i.imgur.com/p6R9Yc8.png)
 </details>
 
 ---
@@ -45,13 +45,13 @@ Press `Ctrl` + `C` to exit.
 $ tird
 
                        MENU
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    0. Exit              1. Show info
+    ———————————————————————————————————————————
+    0. Exit              1. Info
     2. Encrypt           3. Decrypt
     4. Embed             5. Extract
     6. Encrypt & embed   7. Extract & decrypt
     8. Create w/ random  9. Overwrite w/ random
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    ———————————————————————————————————————————
 [01] Select an option [0-9]: ^C
 I: caught signal 2
 ```
@@ -60,7 +60,7 @@ I: caught signal 2
 <details>
 <summary>Screenshot</summary>
 
-![Screenshot](https://i.imgur.com/gAA7AYN.png)
+![Screenshot](https://i.imgur.com/1aydjBN.png)
 </details>
 
 ---
@@ -76,22 +76,22 @@ Press `Ctrl` + `C` to exit. Aborting an unfinished action results in an error ex
 $ tird
 
                        MENU
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    0. Exit              1. Show info
+    ———————————————————————————————————————————
+    0. Exit              1. Info
     2. Encrypt           3. Decrypt
     4. Embed             5. Extract
     6. Encrypt & embed   7. Extract & decrypt
     8. Create w/ random  9. Overwrite w/ random
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-[01] Select an option [0-9]: 8
-I: action #8: create a file with random bytes
-[07] Output file: ^C
+    ———————————————————————————————————————————
+[01] Select an option [0-9]: 2
+I: action #2: encrypt file contents
+[02] Use custom settings? (Y/N, default=N): ^C
 E: caught signal 2
 ```
 </details>
 
 <details>
 <summary>Screenshot</summary>
 
-![Screenshot](https://i.imgur.com/tV1scDO.png)
+![Screenshot](https://i.imgur.com/2p6Qj7D.png)
 </details>
diff --git a/docs/tutorial/1.md b/docs/tutorial/1.md
@@ -3,22 +3,90 @@
 
 #### Show info with action #1:
 
+Select option `0` and press `Enter` to exit the information.
+
+<details>
+<summary>Output</summary>
+
 ```
 $ tird
 
                        MENU
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    0. Exit              1. Show info
+    ———————————————————————————————————————————
+    0. Exit              1. Info
     2. Encrypt           3. Decrypt
     4. Embed             5. Extract
     6. Encrypt & embed   7. Extract & decrypt
     8. Create w/ random  9. Overwrite w/ random
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    ———————————————————————————————————————————
 [01] Select an option [0-9]: 1
-I: action #1: show info
-I: tird v0.9.0
+I: action #1: display info
+I: tird v0.10.0
     A tool for writing random bytes,
     encrypting file contents,
     and hiding encrypted data.
     Homepage: https://github.com/hakavlad/tird
+
+                       MENU
+    ———————————————————————————————————————————
+    0. Exit              1. Info
+    2. Encrypt           3. Decrypt
+    4. Embed             5. Extract
+    6. Encrypt & embed   7. Extract & decrypt
+    8. Create w/ random  9. Overwrite w/ random
+    ———————————————————————————————————————————
+[01] Select an option [0-9]: ^C
+I: caught signal 2
 ```
+</details>
+
+<details>
+<summary>Screenshot</summary>
+
+![Screenshot](https://i.imgur.com/8V1WiYK.png)
+</details>
+
+<details>
+<summary>Output with debug</summary>
+
+```
+$ tird -d
+W: debug messages enabled!
+
+                       MENU
+    ———————————————————————————————————————————
+    0. Exit              1. Info
+    2. Encrypt           3. Decrypt
+    4. Embed             5. Extract
+    6. Encrypt & embed   7. Extract & decrypt
+    8. Create w/ random  9. Overwrite w/ random
+    ———————————————————————————————————————————
+[01] Select an option [0-9]: 1
+I: action #1: display info
+I: tird v0.10.0
+    A tool for writing random bytes,
+    encrypting file contents,
+    and hiding encrypted data.
+    Homepage: https://github.com/hakavlad/tird
+D: Python version 3.9.2 (default, Feb 28 2021, 17:03:44)
+[GCC 10.2.1 20210110] on linux platform
+D: executable: /usr/local/bin/tird
+
+                       MENU
+    ———————————————————————————————————————————
+    0. Exit              1. Info
+    2. Encrypt           3. Decrypt
+    4. Embed             5. Extract
+    6. Encrypt & embed   7. Extract & decrypt
+    8. Create w/ random  9. Overwrite w/ random
+    ———————————————————————————————————————————
+[01] Select an option [0-9]: ^C
+I: caught signal 2
+```
+</details>
+
+<details>
+<summary>Screenshot with debug</summary>
+
+![Screenshot](https://i.imgur.com/28MZJSM.png)
+</details>