Skip to content

Commit

Permalink
added basic usage guide
Browse files Browse the repository at this point in the history
  • Loading branch information
PyryL committed Nov 11, 2023
1 parent 2acc79e commit b06b915
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Implementation of [CRYSTALS-Kyber](https://pq-crystals.org/kyber/index.shtml) en
* [Requirements specification](docs/requirements.md)
* [Implementation]()
* [Testing]()
* [Usage guide]()
* [Usage guide](docs/usage.md)

### Weekly reports

Expand Down
41 changes: 41 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Usage guide

## Installation

Make sure that you have [Poetry](https://python-poetry.org/) installed. After cloning the repository to your computer move to its root directory and run

```
poetry install
```

## Usage

Currently `kyber` provides three main functions that can be used directly from Python code. A sample usage is included in `main.py`.

At the moment there is no GUI or CLI available.

### Tests

Unit tests can be run with

```
poetry run invoke test
```

### Coverage

Coverage report can be created with

```
poetry run invoke coverage-report
```

after which the report will appear at `htmlcov/index.html`.

### Lint

Run static style cheking with

```
poetry run invoke lint
```

0 comments on commit b06b915

Please sign in to comment.