docs: Improve code documentation

This commit is contained in:
dqy
2023-11-15 22:27:37 +08:00
parent 144fabf22c
commit 521e49c9cf
3 changed files with 58 additions and 18 deletions

View File

@@ -35,6 +35,12 @@ The project relies on the following software:
- gmssl
- gmssl-python
### Docker installer
```bash
apt update && apt install docker.io mosh -y
```
### Docker version
docker version:
@@ -64,7 +70,6 @@ pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
docker build . -f basedockerfile -t git.mamahaha.work/sangge/tpre:base
docker pull git.mamahaha.work/sangge/tpre:base
docker build . -t your_image_name
docker run your_image_name
```
### Use pre-build image
@@ -76,6 +81,8 @@ docker run git.mamahaha.work/sangge/tpre:latest
## Usage Instructions
details in [docs](doc/README_app_en.md)
## References
[TPRE Algorithm Blog Post](https://www.cnblogs.com/pam-sh/p/17364656.html#tprelib%E7%AE%97%E6%B3%95)