msb-public
/
cloudreve
mirror of https://github.com/cloudreve/Cloudreve
1
0
Code Issues Projects Releases Wiki Activity

docs(task): update README

Browse Source 
update README

Signed-off-by: kovacs <mritd@linux.com>
pull/1608/head
kovacs 3 years ago
parent 900a4bfa32
commit 97af8e382f
2 changed files with 104 additions and 54 deletions
Show Stats Download Patch File Download Diff File

79
README.md
Unescape View File

@ -74,50 +74,75 @@ The above is a minimum deploy example, you can refer to [Getting started](https:
## :gear: Build ## :gear: Build
You need to have `Go >= 1.18`, `node.js`, `yarn`, `zip` and other necessary dependencies before you can build it yourself. You need to have `Go >= 1.18`, `node.js`, `yarn`, `curl`, `zip`, `go-task` and other necessary dependencies before you can build it yourself.
#### Clone the code #### Install go-task
```shell ```shell
git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
``` ```
#### Build static resources For more installation methods, please refer to the official documentation: [https://taskfile.dev/installation/](https://taskfile.dev/installation/)
#### Clone the code
```shell ```shell
# Enter frontend sub-module git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git
cd assets
# Install dependencies
yarn install
# Start building
yarn run build
# Delete unused map files
cd build
find . -name "*.map" -type f -delete
# Return to main folder to pack static files
cd ../../
zip -r - assets/build >assets.zip
``` ```
#### Compile #### Compile
```shell ```shell
# Obtain version number, commit SHA # Enter the project directory
export COMMIT_SHA=$(git rev-parse --short HEAD) cd Cloudreve
export VERSION=$(git describe --tags)
# Execute the task command
# Note: The `task` command executes the task named `default` by default.
task
# Compile # View compiled files
go build -a -o cloudreve -ldflags "-s -w -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'" ls release
``` ```
You can also start a quick build using `build.sh` in the project root directory: If you want to compile only the frontend code, please execute `task build-frontend`; similarly you can also execute `task build-backend` to only compile the backend code.
You can view all supported tasks through the `task --list` command:
```shell ```shell
./build.sh [-a] [-c] [-b] [-r] ~/Cloudreve ❯❯❯ task --list ✘ 146 master
a - Build assets task: Available tasks for this project:
c - Build binary backend * all: Build All Platform
b - Build both assets and backend * build: Build Cloudreve
r - Cross-compilation for final release * build-backend: Build Backend
* build-frontend: Build Frontend
* clean: Clean All Build Cache
* clean-backend: Clean Backend Build Cache
* clean-frontend: Clean Frontend Build Cache
* darwin-amd64: Build Backend(darwin-amd64)
* darwin-amd64-v2: Build Backend(darwin-amd64-v2)
* darwin-amd64-v3: Build Backend(darwin-amd64-v3)
* darwin-amd64-v4: Build Backend(darwin-amd64-v4)
* darwin-arm64: Build Backend(darwin-arm64)
* freebsd-386: Build Backend(freebsd-386)
* freebsd-amd64: Build Backend(freebsd-amd64)
* freebsd-amd64-v2: Build Backend(freebsd-amd64-v2)
* freebsd-amd64-v3: Build Backend(freebsd-amd64-v3)
* freebsd-amd64-v4: Build Backend(freebsd-amd64-v4)
* freebsd-arm: Build Backend(freebsd-arm)
* freebsd-arm64: Build Backend(freebsd-arm64)
* linux-amd64: Build Backend(linux-amd64)
* linux-amd64-v2: Build Backend(linux-amd64-v2)
* linux-amd64-v3: Build Backend(linux-amd64-v3)
* linux-amd64-v4: Build Backend(linux-amd64-v4)
* linux-armv5: Build Backend(linux-armv5)
* linux-armv6: Build Backend(linux-armv6)
* linux-armv7: Build Backend(linux-armv7)
* linux-armv8: Build Backend(linux-armv8)
* windows-amd64: Build Backend(windows-amd64)
* windows-amd64-v2: Build Backend(windows-amd64-v2)
* windows-amd64-v3: Build Backend(windows-amd64-v3)
* windows-amd64-v4: Build Backend(windows-amd64-v4)
* windows-arm64: Build Backend(windows-arm64)
``` ```
## :alembic: Stacks ## :alembic: Stacks

79
README_zh-CN.md
Unescape View File

@ -74,50 +74,75 @@ chmod +x ./cloudreve
## :gear: 构建 ## :gear: 构建
自行构建前需要拥有 `Go >= 1.18`、`node.js`、`yarn`、`zip` 等必要依赖。 自行构建前需要拥有 `Go >= 1.18`、`node.js`、`yarn`、`curl`、`zip`、`go-task` 等必要依赖。
#### 克隆代码 #### 安装 go-task
```shell ```shell
git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
``` ```
#### 构建静态资源 对于其他平台或者其他安装方式, 请参考官方安装文档: [https://taskfile.dev/installation/](https://taskfile.dev/installation/)
#### 克隆代码
```shell ```shell
# 进入前端子模块 git clone --recurse-submodules https://github.com/cloudreve/Cloudreve.git
cd assets
# 安装依赖
yarn install
# 开始构建
yarn run build
# 构建完成后删除映射文件
cd build
find . -name "*.map" -type f -delete
# 返回项目主目录打包静态资源
cd ../../
zip -r - assets/build >assets.zip
``` ```
#### 编译项目 #### 编译项目
```shell ```shell
# 获得当前版本号、Commit # 进入项目目录
export COMMIT_SHA=$(git rev-parse --short HEAD) cd Cloudreve
export VERSION=$(git describe --tags)
# 执行 task 命令
# 提示: 单独执行 `task` 命令实际上默认执行叫做 `default` 的 task
task
# 开始编译 # 查看已编译好的文件
go build -a -o cloudreve -ldflags "-s -w -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.BackendVersion=$VERSION' -X 'github.com/cloudreve/Cloudreve/v3/pkg/conf.LastCommit=$COMMIT_SHA'" ls release
``` ```
你也可以使用项目根目录下的 `build.sh` 快速开始构建： 如果你期望单独编译前端代码, 请执行 `task build-frontend` 命令; 同样你可以通过执行 `task build-backend` 命令单独编译后端代码.
你可以通过执行 `task --list` 命令查看所以已支持的 task.
```shell ```shell
./build.sh [-a] [-c] [-b] [-r] ~/Cloudreve ❯❯❯ task --list ✘ 146 master ✱
a - 构建静态资源 task: Available tasks for this project:
c - 编译二进制文件 * all: Build All Platform
b - 构建前端 + 编译二进制文件 * build: Build Cloudreve
r - 交叉编译，构建用于release的版本 * build-backend: Build Backend
* build-frontend: Build Frontend
* clean: Clean All Build Cache
* clean-backend: Clean Backend Build Cache
* clean-frontend: Clean Frontend Build Cache
* darwin-amd64: Build Backend(darwin-amd64)
* darwin-amd64-v2: Build Backend(darwin-amd64-v2)
* darwin-amd64-v3: Build Backend(darwin-amd64-v3)
* darwin-amd64-v4: Build Backend(darwin-amd64-v4)
* darwin-arm64: Build Backend(darwin-arm64)
* freebsd-386: Build Backend(freebsd-386)
* freebsd-amd64: Build Backend(freebsd-amd64)
* freebsd-amd64-v2: Build Backend(freebsd-amd64-v2)
* freebsd-amd64-v3: Build Backend(freebsd-amd64-v3)
* freebsd-amd64-v4: Build Backend(freebsd-amd64-v4)
* freebsd-arm: Build Backend(freebsd-arm)
* freebsd-arm64: Build Backend(freebsd-arm64)
* linux-amd64: Build Backend(linux-amd64)
* linux-amd64-v2: Build Backend(linux-amd64-v2)
* linux-amd64-v3: Build Backend(linux-amd64-v3)
* linux-amd64-v4: Build Backend(linux-amd64-v4)
* linux-armv5: Build Backend(linux-armv5)
* linux-armv6: Build Backend(linux-armv6)
* linux-armv7: Build Backend(linux-armv7)
* linux-armv8: Build Backend(linux-armv8)
* windows-amd64: Build Backend(windows-amd64)
* windows-amd64-v2: Build Backend(windows-amd64-v2)
* windows-amd64-v3: Build Backend(windows-amd64-v3)
* windows-amd64-v4: Build Backend(windows-amd64-v4)
* windows-arm64: Build Backend(windows-arm64)
``` ```
## :alembic: 技术栈 ## :alembic: 技术栈

Write Preview
Loading…
Cancel
Save