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 1595660 commit a0dd72f
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 6 deletions.
2 changes: 2 additions & 0 deletions docs/tutorial/0.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

*[Homepage](https://github.com/hakavlad/tird) | [Tutorial](https://github.com/hakavlad/tird/blob/main/docs/tutorial/README.md)*

## Exiting `tird`

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

*[Homepage](https://github.com/hakavlad/tird) | [Tutorial](https://github.com/hakavlad/tird/blob/main/docs/tutorial/README.md)*

## Displaying info

#### Displaying info with action #1:
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorial/23.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

*[Homepage](https://github.com/hakavlad/tird) | [Tutorial](https://github.com/hakavlad/tird/blob/main/docs/tutorial/README.md)*

## Encrypt and decrypt with default options

#### Encrypt
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorial/8.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

*[Homepage](https://github.com/hakavlad/tird) | [Tutorial](https://github.com/hakavlad/tird/blob/main/docs/tutorial/README.md)*

## Creating files with uniform random data

Random data files can be used:
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorial/9.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

*[Homepage](https://github.com/hakavlad/tird) | [Tutorial](https://github.com/hakavlad/tird/blob/main/docs/tutorial/README.md)*

## Overwriting file contents with uniform random data

> \[!CAUTION]
Expand Down
26 changes: 20 additions & 6 deletions docs/tutorial/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@

## Tutorial
# Tutorial

- [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)
- [The simplest case of encryption and decryption](https://github.com/hakavlad/tird/blob/main/docs/tutorial/23.md)
### [0.md](https://github.com/hakavlad/tird/blob/main/docs/tutorial/0.md)

Exiting `tird`.

### [1.md](https://github.com/hakavlad/tird/blob/main/docs/tutorial/1.md)

Displaying info (version, descryption, homepage).

### [23.md](https://github.com/hakavlad/tird/blob/main/docs/tutorial/23.md)

The simplest case of encryption and decryption.

### [8.md](https://github.com/hakavlad/tird/blob/main/docs/tutorial/8.md)

Creating files with uniform random data (creating keyfiles and containers).

### [9.md](https://github.com/hakavlad/tird/blob/main/docs/tutorial/9.md)

Overwriting file contents with uniform random data (destroying residual data and preparing containers).

0 comments on commit a0dd72f

Please sign in to comment.