upload readme and how-to-build

Signed-off-by: Double Sine <xiao_ai_yu@live.cn>
This commit is contained in:
Double Sine
2022-02-14 16:18:30 +08:00
parent 9017721a5c
commit 48d4ac6a78
4 changed files with 136 additions and 0 deletions

37
doc/how-to-build.md Normal file
View File

@@ -0,0 +1,37 @@
# navicat-keygen for linux - How to build?
[中文版](how-to-build.zh-CN.md)
## 1. Prerequisites
1. Install latest `CMake`:
```bash
$ sudo apt-get install cmake
```
2. Install `fmt`, `OpenSSL` and `rapidjson`:
```bash
$ sudo apt-get install libfmt-dev libssl-dev rapidjson-dev
```
## 2. Build
1. Clone:
```bash
$ git clone -b linux --single-branch https://notabug.org/doublesine/navicat-keygen.git
$ cd navicat-keygen
```
2. Build:
```bash
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ cmake --build . -- -j4
```
Then you will see two executable files, `navicat-keygen` and `navicat-patcher`, in `build` directory.

35
doc/how-to-build.zh-CN.md Normal file
View File

@@ -0,0 +1,35 @@
# navicat-keygen for linux - 如何编译?
## 1. 前提条件
1. 安装最新的 `CMake`:
```bash
$ sudo apt-get install cmake
```
2. 安装 `fmt`、`OpenSSL` 和 `rapidjson`:
```bash
$ sudo apt-get install libfmt-dev libssl-dev rapidjson-dev
```
## 2. 编译
1. clone仓库:
```bash
$ git clone -b linux --single-branch https://notabug.org/doublesine/navicat-keygen.git
$ cd navicat-keygen
```
2. 编译:
```bash
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ cmake --build . -- -j4
```
编译完后你会在build文件夹里看到两个可执行文件 `navicat-keygen` 和 `navicat-patcher`。