doc: update readme

This commit is contained in:
sangge 2023-10-23 16:59:35 +08:00
parent 3c6b989039
commit 448f20c9df

View File

@ -21,6 +21,7 @@ The project uses the Chinese national standard cryptography algorithm to impleme
## Environment Dependencies ## Environment Dependencies
### Bare mental version(UNTESTED)
System requirements: System requirements:
- Linux - Linux
- Windows(may need to complie and install gmssl yourself) - Windows(may need to complie and install gmssl yourself)
@ -30,22 +31,24 @@ The project relies on the following software:
- gmssl - gmssl
- gmssl-python - gmssl-python
### Docker version
docker version:
- Version: 24.0.5
- API version: 1.43
- Go version: go1.20.6
## Installation Steps ## Installation Steps
### Pre-installation ### Pre-installation
This project depends on gmssl, so you need to compile it from source first. 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. Visit [GmSSL](https://github.com/guanzhi/GmSSL) to learn how to install.
Then install essential python libs
```bash ```bash
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
``` ```
## Docker Installation ## Docker Installation
my docker version:
- Version: 24.0.5
- API version: 1.43
- Go version: go1.20.6
### Use base image and build yourself ### Use base image and build yourself
```bash ```bash