diff --git a/README.md b/README.md index 07cdc7e..3599510 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,32 @@ We publish binaries for Mac, Windows, and Linux. Available to download for free from [here](https://github.com/tiny-craft/tiny-rdm/releases). +## Build +### Prerequisites +* Go >= 1.21 +* Node.js >= 16 +* NPM + +### Install wails +```bash +go install github.com/wailsapp/wails/v2/cmd/wails@latest +``` + +### Clone the code +```bash +git clone https://github.com/tiny-craft/tiny-rdm --depth=1 +``` + +### Build frontend +```bash +npm install --prefix ./frontend +``` + +### Compile and run +```bash +wails dev +``` + ## License Tiny RDM is licensed under [GNU General Public](/LICENSE) license. diff --git a/README_zh.md b/README_zh.md index 4734beb..d834fd6 100644 --- a/README_zh.md +++ b/README_zh.md @@ -28,6 +28,32 @@ 提供Mac、Windows和Linux下载安装,可[免费下载](https://github.com/tiny-craft/tiny-rdm/releases)。 +## 构建项目 +### 运行环境要求 +* Go >= 1.21 +* Node.js >= 16 +* NPM + +### 安装wails +```bash +go install github.com/wailsapp/wails/v2/cmd/wails@latest +``` + +### 拉取代码 +```bash +git clone https://github.com/tiny-craft/tiny-rdm --depth=1 +``` + +### 构建前端代码 +```bash +npm install --prefix ./frontend +``` + +### 编译运行开发版本 +```bash +wails dev +``` + ## 关于 此APP由我个人开发,也作为本人第一个开源项目的尝试,由于精力有限,可能会存在BUG或者使用体验上的问题,欢迎提交issue和PR。 同时本人也在探索开源代码、独立开发和盈利性商业应用之间的平衡关系,欢迎有共同意向的小伙伴加入群聊探讨和交换想法。 diff --git a/go.mod b/go.mod index bb6fb37..61f3e19 100644 --- a/go.mod +++ b/go.mod @@ -6,7 +6,7 @@ require ( github.com/adrg/sysfont v0.1.2 github.com/bytedance/sonic v1.10.0 github.com/google/go-cmp v0.5.9 - github.com/redis/go-redis/v9 v9.0.5 + github.com/redis/go-redis/v9 v9.1.0 github.com/vrischmann/userdir v0.0.0-20151206171402-20f291cebd68 github.com/wailsapp/wails/v2 v2.5.1 gopkg.in/yaml.v3 v3.0.1 diff --git a/go.sum b/go.sum index 08b2614..4cae6fb 100644 --- a/go.sum +++ b/go.sum @@ -74,6 +74,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/redis/go-redis/v9 v9.0.5 h1:CuQcn5HIEeK7BgElubPP8CGtE0KakrnbBSTLjathl5o= github.com/redis/go-redis/v9 v9.0.5/go.mod h1:WqMKv5vnQbRuZstUwxQI195wHy+t4PuXDOjzMvcuQHk= +github.com/redis/go-redis/v9 v9.1.0 h1:137FnGdk+EQdCbye1FW+qOEcY5S+SpY9T0NiuqvtfMY= +github.com/redis/go-redis/v9 v9.1.0/go.mod h1:urWj3He21Dj5k4TK1y59xH8Uj6ATueP8AH1cY3lZl4c= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis= github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=