doc: update readme
This commit is contained in:
parent
89992080d0
commit
b823380310
21
README_en.md
21
README_en.md
@ -8,6 +8,10 @@ The project uses the Chinese national standard cryptography algorithm to impleme
|
|||||||
|
|
||||||
## Environment Dependencies
|
## Environment Dependencies
|
||||||
|
|
||||||
|
System requirements:
|
||||||
|
- Linux
|
||||||
|
- Windows
|
||||||
|
|
||||||
The project relies on the following software:
|
The project relies on the following software:
|
||||||
- Python 3.11
|
- Python 3.11
|
||||||
- gmssl
|
- gmssl
|
||||||
@ -15,6 +19,21 @@ The project relies on the following software:
|
|||||||
|
|
||||||
## Installation Steps
|
## Installation Steps
|
||||||
|
|
||||||
|
### Pre-installation
|
||||||
|
This project depends on gmssl, so you need to compile it from source first.
|
||||||
|
Visit [GmSSL](https://github.com/guanzhi/GmSSL) to learn how to install.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install
|
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage Instructions
|
||||||
|
|
||||||
|
|
||||||
|
## References
|
||||||
|
[TPRE Algorithm Blog Post](https://www.cnblogs.com/pam-sh/p/17364656.html#tprelib%E7%AE%97%E6%B3%95)
|
||||||
|
[Gmssl-python library](https://github.com/GmSSL/GmSSL-Python)
|
||||||
|
|
||||||
|
|
||||||
|
## License
|
||||||
|
GNU GENERAL PUBLIC LICENSE v3
|
||||||
|
Loading…
x
Reference in New Issue
Block a user