Skip to content

Commit f2ddac8

Browse files
committed
Add links to documentation
1 parent b997d01 commit f2ddac8

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,9 @@ The encryption follows the [RSA algorithm](https://en.wikipedia.org/wiki/RSA_(cr
1212
* [Week 5](https://github.com/SiniCode/keysmith/blob/main/documentation/weekly_report_5.md)
1313
* [Week 6](https://github.com/SiniCode/keysmith/blob/main/documentation/weekly_report_6.md)
1414

15-
## Instructions for Use
15+
## Documentation
1616

17-
Before running the app for the first time, install the necessary dependencies with this command:
18-
19-
```bash
20-
poetry install
21-
```
22-
23-
Launch the app with this command:
24-
25-
```bash
26-
poetry run invoke start
27-
```
17+
* [Instructions for Use](https://github.com/SiniCode/keysmith/blob/main/documentation/instructions.md)
18+
* [Project Specification](https://github.com/SiniCode/keysmith/blob/main/documentation/project_specification.md)
19+
* [Implementation](https://github.com/SiniCode/keysmith/blob/main/documentation/implementation.md)
20+
* [Testing Document](https://github.com/SiniCode/keysmith/blob/main/documentation/testing.md)

0 commit comments

Comments
 (0)