mirror of
https://github.com/siyuan-note/siyuan.git
synced 2025-09-22 00:20:47 +02:00
docs: change to conventionally named (#5082)
This commit is contained in:
parent
dc02a761b2
commit
e113322340
7 changed files with 34 additions and 31 deletions
26
DEV.md → .github/CONTRIBUTING.md
vendored
26
DEV.md → .github/CONTRIBUTING.md
vendored
|
@ -1,25 +1,33 @@
|
||||||
[中文](https://github.com/siyuan-note/siyuan/blob/master/DEV_zh_CN.md)
|
[中文](CONTRIBUTING_zh_CN.md)
|
||||||
|
|
||||||
## Get the source code
|
## Get the source code
|
||||||
|
|
||||||
* `git clone --recurse-submodules git@github.com:siyuan-note/siyuan.git` For example saved in `D:/siyuan/`
|
* `git clone --recurse-submodules git@github.com:siyuan-note/siyuan.git` For example saved in `D:/siyuan/`
|
||||||
* switch to dev branch
|
* switch to dev branch
|
||||||
|
|
||||||
## NPM dependencies
|
## User Interface
|
||||||
|
|
||||||
Install pnpm
|
Install pnpm
|
||||||
|
|
||||||
`npm install -g pnpm`
|
`npm install -g pnpm`
|
||||||
|
|
||||||
In China, it may be necessary to set the Electron mirror environment variable:
|
<details>
|
||||||
|
<summary>For China mainland</summary>
|
||||||
|
Set the Electron mirror environment variable:
|
||||||
|
|
||||||
* macOS/Linux: ELECTRON_MIRROR="https://cnpmjs.org/mirrors/electron/" pnpm install electron@14.2.5 -D
|
* macOS/Linux: ELECTRON_MIRROR="https://cnpmjs.org/mirrors/electron/" pnpm install electron@14.2.5 -D
|
||||||
* Windows: `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/`
|
* Windows: `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/`
|
||||||
|
|
||||||
NPM mirror:
|
NPM mirror:
|
||||||
|
|
||||||
* May need to use mirror repository in China `pnpm --registry https://r.cnpmjs.org/ i`
|
* Use mirror repository `pnpm --registry https://r.cnpmjs.org/ i`
|
||||||
* Revert to using official repository `pnpm --registry https://registry.npmjs.org i`
|
* Revert to using official repository `pnpm --registry https://registry.npmjs.org i`
|
||||||
|
</details>
|
||||||
|
|
||||||
|
On the desktop, go to the app folder to compile and run:
|
||||||
|
|
||||||
|
* `pnpm run dev`
|
||||||
|
* `pnpm run start`
|
||||||
|
|
||||||
## Kernel
|
## Kernel
|
||||||
|
|
||||||
|
@ -27,7 +35,8 @@ NPM mirror:
|
||||||
|
|
||||||
* `cd kernel`
|
* `cd kernel`
|
||||||
* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"`
|
* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"`
|
||||||
* `SiYuan-Kernel.exe --wd=D:/siyuan/app --mode=dev`
|
* `cd ../app/kernel`
|
||||||
|
* `./SiYuan-Kernel.exe --wd=.. --mode=dev`
|
||||||
|
|
||||||
### iOS
|
### iOS
|
||||||
|
|
||||||
|
@ -41,11 +50,4 @@ NPM mirror:
|
||||||
* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm,android/arm64' ./mobile/`
|
* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm,android/arm64' ./mobile/`
|
||||||
* https://github.com/siyuan-note/siyuan-android
|
* https://github.com/siyuan-note/siyuan-android
|
||||||
|
|
||||||
## User Interface
|
|
||||||
|
|
||||||
On the desktop, go to the app folder to compile and run:
|
|
||||||
|
|
||||||
* `npm run dev`
|
|
||||||
* `npm run start`
|
|
||||||
|
|
||||||
For the mobile-end, please refer to the corresponding project repository.
|
For the mobile-end, please refer to the corresponding project repository.
|
23
DEV_zh_CN.md → .github/CONTRIBUTING_zh_CN.md
vendored
23
DEV_zh_CN.md → .github/CONTRIBUTING_zh_CN.md
vendored
|
@ -1,4 +1,4 @@
|
||||||
[English](https://github.com/siyuan-note/siyuan/blob/master/DEV.md)
|
[English](CONTRIBUTING.md)
|
||||||
|
|
||||||
## 获取源码
|
## 获取源码
|
||||||
|
|
||||||
|
@ -11,23 +11,31 @@
|
||||||
|
|
||||||
`npm install -g pnpm`
|
`npm install -g pnpm`
|
||||||
|
|
||||||
在中国可能需要设置 Electron 镜像环境变量:
|
<details>
|
||||||
|
<summary>适用于中国大陆</summary>
|
||||||
|
设置 Electron 镜像环境变量:
|
||||||
|
|
||||||
* macOS/Linux:ELECTRON_MIRROR="https://cnpmjs.org/mirrors/electron/" pnpm install electron@14.2.5 -D
|
* macOS/Linux:ELECTRON_MIRROR="https://cnpmjs.org/mirrors/electron/" pnpm install electron@14.2.5 -D
|
||||||
* Windows: `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/`
|
* Windows: `SET ELECTRON_MIRROR=https://cnpmjs.org/mirrors/electron/`
|
||||||
|
|
||||||
NPM 镜像:
|
NPM 镜像:
|
||||||
|
|
||||||
* 在中国可能需要使用镜像仓库 `pnpm --registry https://r.cnpmjs.org/ i`
|
* 使用镜像仓库 `pnpm --registry https://r.cnpmjs.org/ i`
|
||||||
* 恢复使用官方仓库 `pnpm --registry https://registry.npmjs.org i`
|
* 恢复使用官方仓库 `pnpm --registry https://registry.npmjs.org i`
|
||||||
|
</details>
|
||||||
|
|
||||||
|
桌面端进入 app 文件夹编译和运行:
|
||||||
|
|
||||||
|
* `pnpm run dev`
|
||||||
|
* `pnpm run start`
|
||||||
## 内核
|
## 内核
|
||||||
|
|
||||||
### 桌面端
|
### 桌面端
|
||||||
|
|
||||||
* `cd kernel`
|
* `cd kernel`
|
||||||
* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"`
|
* `go build --tags "fts5" -o "../app/kernel/SiYuan-Kernel.exe"`
|
||||||
* `SiYuan-Kernel.exe --wd=D:/siyuan/app --mode=dev`
|
* `cd ../app/kernel`
|
||||||
|
* `./SiYuan-Kernel.exe --wd=.. --mode=dev`
|
||||||
|
|
||||||
### iOS
|
### iOS
|
||||||
|
|
||||||
|
@ -39,11 +47,4 @@ NPM 镜像:
|
||||||
* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm,android/arm64' ./kernel/mobile/`
|
* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm,android/arm64' ./kernel/mobile/`
|
||||||
* https://github.com/siyuan-note/siyuan-android
|
* https://github.com/siyuan-note/siyuan-android
|
||||||
|
|
||||||
## 用户界面
|
|
||||||
|
|
||||||
桌面端进入 app 文件夹编译和运行:
|
|
||||||
|
|
||||||
* `npm run dev`
|
|
||||||
* `npm run start`
|
|
||||||
|
|
||||||
移动端请参考对应项目仓库。
|
移动端请参考对应项目仓库。
|
0
FUNDING.yml → .github/FUNDING.yml
vendored
0
FUNDING.yml → .github/FUNDING.yml
vendored
|
@ -10,7 +10,7 @@ Build Your Eternal Digital Garden
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/siyuan-note/siyuan/blob/master/README_zh_CN.md">中文</a>
|
<a href="README_zh_CN.md">中文</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 💡 Introduction
|
## 💡 Introduction
|
||||||
|
@ -79,7 +79,7 @@ Cloud services require a paid subscription.
|
||||||
## 🗺️ Roadmap
|
## 🗺️ Roadmap
|
||||||
|
|
||||||
* [SiYuan development plan and progress](https://github.com/siyuan-note/siyuan/projects)
|
* [SiYuan development plan and progress](https://github.com/siyuan-note/siyuan/projects)
|
||||||
* [SiYuan Change logs](https://github.com/siyuan-note/siyuan/blob/master/CHANGE_LOGS.md)
|
* [SiYuan Change logs](CHANGELOG.md)
|
||||||
|
|
||||||
## 🛠️ Download Setup
|
## 🛠️ Download Setup
|
||||||
|
|
||||||
|
@ -176,7 +176,7 @@ SiYuan is completely open source, and contributions are welcome:
|
||||||
* [Android](https://github.com/siyuan-note/siyuan-android)
|
* [Android](https://github.com/siyuan-note/siyuan-android)
|
||||||
* [iOS](https://github.com/siyuan-note/siyuan-ios)
|
* [iOS](https://github.com/siyuan-note/siyuan-ios)
|
||||||
|
|
||||||
For more details, please refer to [Development Guide](https://github.com/siyuan-note/siyuan/blob/master/DEV.md).
|
For more details, please refer to [Development Guide](.github/CONTRIBUTING.md).
|
||||||
|
|
||||||
### Is there any note for deleting docs?
|
### Is there any note for deleting docs?
|
||||||
|
|
||||||
|
@ -233,7 +233,7 @@ SiYuan is completely open source, and contributions are welcome:
|
||||||
* [Android](https://github.com/siyuan-note/siyuan-android)
|
* [Android](https://github.com/siyuan-note/siyuan-android)
|
||||||
* [iOS](https://github.com/siyuan-note/siyuan-ios)
|
* [iOS](https://github.com/siyuan-note/siyuan-ios)
|
||||||
|
|
||||||
For more details, please refer to [Development Guide](https://github.com/siyuan-note/siyuan/blob/master/DEV.md).
|
For more details, please refer to [Development Guide](.github/CONTRIBUTING.md).
|
||||||
|
|
||||||
## 🙏 Acknowledgement
|
## 🙏 Acknowledgement
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/siyuan-note/siyuan/blob/master/README.md">English</a>
|
<a href="README.md">English</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 💡 简介
|
## 💡 简介
|
||||||
|
@ -66,7 +66,7 @@
|
||||||
* Android APP
|
* Android APP
|
||||||
* iOS APP
|
* iOS APP
|
||||||
* Docker 部署
|
* Docker 部署
|
||||||
* [API](https://github.com/siyuan-note/siyuan/blob/master/API_zh_CN.md)
|
* [API](API_zh_CN.md)
|
||||||
|
|
||||||
### 付费订阅
|
### 付费订阅
|
||||||
|
|
||||||
|
@ -184,7 +184,7 @@
|
||||||
* [Android 端](https://github.com/siyuan-note/siyuan-android)
|
* [Android 端](https://github.com/siyuan-note/siyuan-android)
|
||||||
* [iOS 端](https://github.com/siyuan-note/siyuan-ios)
|
* [iOS 端](https://github.com/siyuan-note/siyuan-ios)
|
||||||
|
|
||||||
更多细节请参考[开发指南](https://github.com/siyuan-note/siyuan/blob/master/DEV_zh_CN.md)。
|
更多细节请参考[开发指南](.github/CONTRIBUTING_zh_CN.md)。
|
||||||
|
|
||||||
### 删除文档有什么注意事项吗?
|
### 删除文档有什么注意事项吗?
|
||||||
|
|
||||||
|
@ -241,7 +241,7 @@
|
||||||
* [Android 端](https://github.com/siyuan-note/siyuan-android)
|
* [Android 端](https://github.com/siyuan-note/siyuan-android)
|
||||||
* [iOS 端](https://github.com/siyuan-note/siyuan-ios)
|
* [iOS 端](https://github.com/siyuan-note/siyuan-ios)
|
||||||
|
|
||||||
更多细节请参考[开发指南](https://github.com/siyuan-note/siyuan/blob/master/DEV_zh_CN.md)。
|
更多细节请参考[开发指南](.github/CONTRIBUTING_zh_CN.md)。
|
||||||
|
|
||||||
## 🙏 鸣谢
|
## 🙏 鸣谢
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue