From f544ab3d81b55ae6ab827ea1b6b4afef2719bba5 Mon Sep 17 00:00:00 2001 From: appdev Date: Mon, 18 Dec 2023 15:02:06 +0800 Subject: [PATCH] Delete .github directory --- .github/CONTRIBUTING.md | 63 ------------------------------ .github/CONTRIBUTING_zh_CN.md | 65 ------------------------------- .github/workflows/dockerimage.yml | 52 ------------------------- 3 files changed, 180 deletions(-) delete mode 100644 .github/CONTRIBUTING.md delete mode 100644 .github/CONTRIBUTING_zh_CN.md delete mode 100644 .github/workflows/dockerimage.yml diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 3a6e6580a..000000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,63 +0,0 @@ -[中文](CONTRIBUTING_zh_CN.md) - -## Get the source code - -* `git clone --depth=1 git@github.com:siyuan-note/siyuan.git` -* switch to dev branch `git checkout dev` - -Note: `app/stage/protyle/**` is managed by git lfs, and you don't need to pay attention to it under normal circumstances, related to [#9253](https://github.com/siyuan-note/siyuan/issues/9253). - -## User Interface - -Install pnpm: `npm install -g pnpm` - -
-For China mainland - -Set the Electron mirror environment variable and install Electron: - -* macOS/Linux: `ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/ pnpm install electron@25.9.4 -D` -* Windows: - * `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/` - * `pnpm install electron@25.9.4 -D` - -NPM mirror: - -* Use npmmirror China mirror repository `pnpm --registry https://r.cnpmjs.org/ i` -* Revert to using official repository `pnpm --registry https://registry.npmjs.org i` - -
- -On the desktop, go to the app folder to run: - -* `pnpm install electron@25.9.4 -D` -* `pnpm run dev` -* `pnpm run start` - -Note: In the development environment, the kernel process will not be automatically started, and you need to manually start the kernel process first. - -## Kernel - -1. Install the latest version of [golang](https://go.dev/) -2. Open CGO support, that is, configure the environment variable `CGO_ENABLED=1` - -### Desktop - -* `cd kernel` -* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"` -* `cd ../app/kernel` -* `./SiYuan-Kernel.exe --wd=.. --mode=dev` - -### iOS - -* `cd kernel` -* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o ./ios/iosk.xcframework -target=ios ./mobile/` -* https://github.com/siyuan-note/siyuan-ios - -### Android - -* `cd kernel` -* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm64' -androidapi 24 ./mobile/` -* https://github.com/siyuan-note/siyuan-android - -For the mobile-end, please refer to the corresponding project repository. diff --git a/.github/CONTRIBUTING_zh_CN.md b/.github/CONTRIBUTING_zh_CN.md deleted file mode 100644 index 2c7432ccb..000000000 --- a/.github/CONTRIBUTING_zh_CN.md +++ /dev/null @@ -1,65 +0,0 @@ -[English](CONTRIBUTING.md) - -## 获取源码 - -* `git clone --depth=1 git@github.com:siyuan-note/siyuan.git` -* 切换到 dev 分支 `git checkout dev` - -备注：`app/stage/protyle/**` 使用 git lfs 管理，正常情况下无需关注，关联 [#9253](https://github.com/siyuan-note/siyuan/issues/9253)。 - -## NPM 依赖 - -安装 pnpm：`npm install -g pnpm` - -
-适用于中国大陆 - -设置 Electron 镜像环境变量并安装 Electron： - -* macOS/Linux: - ``` - ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/ pnpm install electron@25.9.4 -D - ``` -* Windows: - * `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/` - * `pnpm install electron@25.9.4 -D` - -NPM 镜像： - -* 使用 npmmirror 中国镜像仓库 `pnpm --registry https://r.cnpmjs.org/ i` -* 恢复使用官方仓库 `pnpm --registry https://registry.npmjs.org i` -
- -桌面端进入 app 文件夹运行： - -* `pnpm install electron@25.9.4 -D` -* `pnpm run dev` -* `pnpm run start` - -注意：在开发环境下不会自动拉起内核进程，需要先手动拉起内核进程。 - -## 内核 - -1. 安装最新版 [golang](https://go.dev/) -2. 打开 CGO 支持，即配置环境变量 `CGO_ENABLED=1` - -### 桌面端 - -* `cd kernel` -* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"` -* `cd ../app/kernel` -* `./SiYuan-Kernel.exe --wd=.. --mode=dev` - -### iOS - -* `cd kernel` -* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o ./ios/iosk.xcframework -target=ios ./mobile/` -* https://github.com/siyuan-note/siyuan-ios - -### Android - -* `cd kernel` -* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm64' -androidapi 24 ./mobile/` -* https://github.com/siyuan-note/siyuan-android - -移动端请参考对应项目仓库。 diff --git a/.github/workflows/dockerimage.yml b/.github/workflows/dockerimage.yml deleted file mode 100644 index 0f8cc04c9..000000000 --- a/.github/workflows/dockerimage.yml +++ /dev/null @@ -1,52 +0,0 @@ -name: Release Docker Image - -on: - workflow_dispatch: - push: - branches: - - master - -jobs: - build: - name: build - runs-on: ubuntu-latest - - permissions: - packages: write - contents: read - - steps: - - name: Free Disk Space (Ubuntu) - uses: jlumbroso/free-disk-space@main - with: - # this might remove tools that are actually needed, - # if set to "true" but frees about 6 GB - tool-cache: false - - # all of these default to true, but feel free to set to - # "false" if necessary for your workflow - android: true - dotnet: true - haskell: true - large-packages: true - docker-images: true - swap-storage: true - - - name: Check out the repo - uses: actions/checkout@v3 - - - name: Set up QEMU - uses: docker/setup-qemu-action@v2 - - - name: Setup Docker buildx - uses: docker/setup-buildx-action@v2 - - - name: Log in to Docker Hub - uses: docker/login-action@v2 - with: - username: ${{ secrets.DOCKER_HUB_USER }} - password: ${{ secrets.DOCKER_HUB_PWD }} - - - name: Build the Docker image - run: | - docker buildx build --push --platform linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v8 -t b3log/siyuan:latest -t b3log/siyuan:v2.10.16 . \ No newline at end of file