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
No known key found for this signature in database
GPG Key ID: 44460E4F43EA8633
4 changed files with 136 additions and 0 deletions

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# navicat-keygen for linux
[中文版README](README.zh-CN.md)
This repository will tell you how Navicat offline activation works.
Previous code is archived in [`linux-archived`](https://notabug.org/doublesine/navicat-keygen/src/linux-archived) branch for the reason that Navicat has come to version 16.x.x which I think should be a milestone and I decide to obsolete previous code and rewrite new one.
When you git-clone this repo, please add `--single-branch` flag so that archived branches won't be cloned to your computer, which saves your time and disk.
```console
$ git clone -b linux --single-branch https://notabug.org/doublesine/navicat-keygen.git
```
## 1. How does it work?
see [here](doc/how-does-it-work.md). (WAIT TO BE DONE)
## 2. How to build?
see [here](doc/how-to-build.md).
## 3. How to use?
see [here](doc/how-to-use.md). (WAIT TO BE DONE)
## 4. Contributor
* Deltafox79
* dragonflylee
* zenuo

31
README.zh-CN.md Normal file
View File

@ -0,0 +1,31 @@
# navicat-keygen for linux
这份repo将会告诉你Navicat是怎么完成离线激活的。
归档的代码位于 [`linux-archived`](https://notabug.org/doublesine/navicat-keygen/src/linux-archived) 分支。归档原因Navicat进入16.x.x版本本项目打算进行重构。
当你clone该仓库的时候请使用 `--single-branch` 选项以此避免clone到已被归档的分支、以及节省你的时间和磁盘空间。
```console
$ git clone -b linux --single-branch https://notabug.org/doublesine/navicat-keygen.git
```
## 1. 注册机是怎么工作的?
见[这里](doc/how-does-it-work.zh-CN.md)。(待完成)
## 2. 如何编译?
见[这里](doc/how-to-build.zh-CN.md)。
## 3. 如何使用这个注册机?
见[这里](doc/how-to-use.zh-CN.md)。(待完成)
## 4. 贡献者
* Deltafox79
* dragonflylee
* zenuo

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`