Skip to content

Commit

Permalink
Update tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
hakavlad committed Apr 13, 2024
1 parent 2f1b619 commit bf378e5
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 15 deletions.
8 changes: 4 additions & 4 deletions docs/tutorial/0.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

## Exit
## Exiting `tird`

---

#### Exit with action #0
#### Exiting `tird` with action #0

Select option `0` and press `Enter` to exit the menu.

Expand Down Expand Up @@ -34,7 +34,7 @@ I: action #0: exit

---

#### Exit with `Ctrl` + `C`
#### Exiting `tird` with `Ctrl` + `C`

Press `Ctrl` + `C` to exit.

Expand Down Expand Up @@ -65,7 +65,7 @@ I: caught signal 2

---

#### Exit from an ongoing action with `Ctrl` + `C`
#### Exiting `tird` from an ongoing action with `Ctrl` + `C`

Press `Ctrl` + `C` to exit. Aborting an unfinished action results in an error exit.

Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial/1.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

## Show info
## Displaying info

#### Show info with action #1:
#### Displaying info with action #1:

Select option `0` and press `Enter` to exit the information.
Select option `1` and press `Enter` to display the information (`tird` version, description and homepage).

<details>
<summary>Screenshot</summary>
Expand Down
4 changes: 4 additions & 0 deletions docs/tutorial/23.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

#### Encrypt

Encrypt 500000-byte `file1` into `file2`.

<details>
<summary>Screenshot</summary>

Expand Down Expand Up @@ -60,6 +62,8 @@ I: action is completed

#### Decrypt

Decrypt `file2` into `file3`.

<details>
<summary>Screenshot</summary>

Expand Down
7 changes: 0 additions & 7 deletions docs/tutorial/8.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,8 @@ I: action is completed
```
</details>


---







#### Creating 3 GB file

<details>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Tutorial

- [Exiting](https://github.com/hakavlad/tird/blob/main/docs/tutorial/0.md)
- [Exiting `tird`](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)
Expand Down

0 comments on commit bf378e5

Please sign in to comment.