Update tutorial

hakavlad · Apr 13, 2024 · 2f1b619 · 2f1b619
1 parent 1e4e174
commit 2f1b619
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 63 deletions.
diff --git a/docs/tutorial/0.md b/docs/tutorial/0.md
@@ -7,6 +7,12 @@
 
 Select option `0` and press `Enter` to exit the menu.
 
+<details>
+<summary>Screenshot</summary>
+
+![Screenshot](https://i.imgur.com/p6R9Yc8.png)
+</details>
+
 <details>
 <summary>Output</summary>
 
@@ -26,18 +32,18 @@ I: action #0: exit
 ```
 </details>
 
-<details>
-<summary>Screenshot</summary>
-
-![Screenshot](https://i.imgur.com/p6R9Yc8.png)
-</details>
-
 ---
 
 #### Exit with `Ctrl` + `C`
 
 Press `Ctrl` + `C` to exit.
 
+<details>
+<summary>Screenshot</summary>
+
+![Screenshot](https://i.imgur.com/1aydjBN.png)
+</details>
+
 <details>
 <summary>Output</summary>
 
@@ -57,18 +63,18 @@ I: caught signal 2
 ```
 </details>
 
-<details>
-<summary>Screenshot</summary>
-
-![Screenshot](https://i.imgur.com/1aydjBN.png)
-</details>
-
 ---
 
 #### Exit from an ongoing action with `Ctrl` + `C`
 
 Press `Ctrl` + `C` to exit. Aborting an unfinished action results in an error exit.
 
+<details>
+<summary>Screenshot</summary>
+
+![Screenshot](https://i.imgur.com/2p6Qj7D.png)
+</details>
+
 <details>
 <summary>Output</summary>
 
@@ -89,9 +95,3 @@ I: action #2: encrypt file contents
 E: caught signal 2
 ```
 </details>
-
-<details>
-<summary>Screenshot</summary>
-
-![Screenshot](https://i.imgur.com/2p6Qj7D.png)
-</details>
diff --git a/docs/tutorial/1.md b/docs/tutorial/1.md
@@ -5,6 +5,12 @@
 
 Select option `0` and press `Enter` to exit the information.
 
+<details>
+<summary>Screenshot</summary>
+
+![Screenshot](https://i.imgur.com/8V1WiYK.png)
+</details>
+
 <details>
 <summary>Output</summary>
 
@@ -41,13 +47,13 @@ I: caught signal 2
 </details>
 
 <details>
-<summary>Screenshot</summary>
+<summary>Screenshot with debug messages enabled</summary>
 
-![Screenshot](https://i.imgur.com/8V1WiYK.png)
+![Screenshot](https://i.imgur.com/28MZJSM.png)
 </details>
 
 <details>
-<summary>Output with debug</summary>
+<summary>Output with debug messages endbled</summary>
 
 ```
 $ tird -d
@@ -84,9 +90,3 @@ D: executable: /usr/local/bin/tird
 I: caught signal 2
 ```
 </details>
-
-<details>
-<summary>Screenshot with debug</summary>
-
-![Screenshot](https://i.imgur.com/28MZJSM.png)
-</details>
diff --git a/docs/tutorial/23.md b/docs/tutorial/23.md
@@ -3,6 +3,12 @@
 
 #### Encrypt
 
+<details>
+<summary>Screenshot</summary>
+
+![Screenshot](https://i.imgur.com/uZY88k1.png)
+</details>
+
 <details>
 <summary>Output</summary>
 
@@ -50,17 +56,16 @@ I: action is completed
     ———————————————————————————————————————————
 [01] Select an option [0-9]:
 ```
-
 </details>
 
+#### Decrypt
+
 <details>
 <summary>Screenshot</summary>
 
-![Screenshot](https://i.imgur.com/uZY88k1.png)
+![Screenshot](https://i.imgur.com/MsaoqoZ.png)
 </details>
 
-#### Decrypt
-
 <details>
 <summary>Output</summary>
 
@@ -108,13 +113,7 @@ I: action is completed
 ```
 </details>
 
-<details>
-<summary>Screenshot</summary>
-
-![Screenshot](https://i.imgur.com/MsaoqoZ.png)
-</details>
-
-#### Encrypt with debug
+#### Encrypt with debug messages enabled
 
 <details>
 <summary>Output</summary>

diff --git a/docs/tutorial/8.md b/docs/tutorial/8.md
@@ -11,7 +11,13 @@ You can create files with random data of any size by selecting option 8 in the m
 
 ---
 
-#### Creating 1 kB file:
+#### Creating 1 kB file
+
+<details>
+<summary>Screenshot</summary>
+
+![Screenshot](https://i.imgur.com/gVMPCKz.png)
+</details>
 
 <details>
 <summary>Output</summary>
@@ -50,17 +56,13 @@ I: action is completed
 </details>
 
 <details>
-<summary>Screenshot</summary>
+<summary>Screenshot with debug messages enabled</summary>
 
-![Screenshot](https://i.imgur.com/gVMPCKz.png)
+![Screenshot](https://i.imgur.com/fUkUQGd.png)
 </details>
 
----
-
-#### Creating 1 kB file with debug messages enabled:
-
 <details>
-<summary>Output</summary>
+<summary>Output with debug messages enabled</summary>
 
 ```
 $ tird -d
@@ -101,16 +103,23 @@ I: action is completed
 ```
 </details>
 
+
+---
+
+
+
+
+
+
+
+#### Creating 3 GB file
+
 <details>
 <summary>Screenshot</summary>
 
-![Screenshot](https://i.imgur.com/fUkUQGd.png)
+![Screenshot](https://i.imgur.com/PAJQxdi.png)
 </details>
 
----
-
-#### Creating 3 GB file:
-
 <details>
 <summary>Output</summary>
 
@@ -150,16 +159,13 @@ I: action is completed
 </details>
 
 <details>
-<summary>Screenshot</summary>
+<summary>Screenshot with debug messages enabled</summary>
 
-![Screenshot](https://i.imgur.com/PAJQxdi.png)
+![Screenshot](https://i.imgur.com/Gc2LGkT.png)
 </details>
----
-
-#### Creating 3 GB file with debug messages enabled:
 
 <details>
-<summary>Output</summary>
+<summary>Output with debug messages enabled</summary>
 
 ```
 $ tird -d
@@ -201,9 +207,3 @@ I: action is completed
 [01] Select an option [0-9]:
 ```
 </details>
-
-<details>
-<summary>Screenshot</summary>
-
-![Screenshot](https://i.imgur.com/Gc2LGkT.png)
-</details>
diff --git a/docs/tutorial/README.md b/docs/tutorial/README.md
@@ -1,5 +1,8 @@
 
 ## Tutorial
 
+- [Exiting](https://github.com/hakavlad/tird/blob/main/docs/tutorial/0.md)
+- [Displaying info (version, descryption, homepage)](https://github.com/hakavlad/tird/blob/main/docs/tutorial/1.md)
 - [Creating files with uniform random data](https://github.com/hakavlad/tird/blob/main/docs/tutorial/8.md) (creating keyfiles and containers)
 - [Overwriting file contents with uniform random data](https://github.com/hakavlad/tird/blob/main/docs/tutorial/9.md) (destroying residual data and preparing containers)
+- [The simplest case of encryption and decryption](https://github.com/hakavlad/tird/blob/main/docs/tutorial/23.md)