diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
similarity index 100%
rename from CODE_OF_CONDUCT.md
rename to .github/CODE_OF_CONDUCT.md
diff --git a/DEV.md b/.github/CONTRIBUTING.md
similarity index 75%
rename from DEV.md
rename to .github/CONTRIBUTING.md
index 2b57cc6bb..0fafdb749 100644
--- a/DEV.md
+++ b/.github/CONTRIBUTING.md
@@ -1,25 +1,33 @@
-[中文](https://github.com/siyuan-note/siyuan/blob/master/DEV_zh_CN.md)
+[中文](CONTRIBUTING_zh_CN.md)
## Get the source code
* `git clone --recurse-submodules git@github.com:siyuan-note/siyuan.git` For example saved in `D:/siyuan/`
* switch to dev branch
-## NPM dependencies
+## User Interface
Install pnpm
`npm install -g pnpm`
-In China, it may be necessary to set the Electron mirror environment variable:
+
+For China mainland
+Set the Electron mirror environment variable:
* 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/`
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`
+
+
+On the desktop, go to the app folder to compile and run:
+
+* `pnpm run dev`
+* `pnpm run start`
## Kernel
@@ -27,7 +35,8 @@ NPM mirror:
* `cd kernel`
* `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
@@ -41,11 +50,4 @@ NPM mirror:
* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o kernel.aar -target='android/arm,android/arm64' ./mobile/`
* 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.
diff --git a/DEV_zh_CN.md b/.github/CONTRIBUTING_zh_CN.md
similarity index 75%
rename from DEV_zh_CN.md
rename to .github/CONTRIBUTING_zh_CN.md
index c4c8153fa..2772d5265 100644
--- a/DEV_zh_CN.md
+++ b/.github/CONTRIBUTING_zh_CN.md
@@ -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`
-在中国可能需要设置 Electron 镜像环境变量：
+
+适用于中国大陆
+设置 Electron 镜像环境变量：
* 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/`
NPM 镜像：
-* 在中国可能需要使用镜像仓库 `pnpm --registry https://r.cnpmjs.org/ i`
+* 使用镜像仓库 `pnpm --registry https://r.cnpmjs.org/ i`
* 恢复使用官方仓库 `pnpm --registry https://registry.npmjs.org i`
+
+桌面端进入 app 文件夹编译和运行：
+
+* `pnpm run dev`
+* `pnpm run start`
## 内核
### 桌面端
* `cd kernel`
* `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
@@ -39,11 +47,4 @@ NPM 镜像：
* `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
-## 用户界面
-
-桌面端进入 app 文件夹编译和运行：
-
-* `npm run dev`
-* `npm run start`
-
移动端请参考对应项目仓库。
diff --git a/FUNDING.yml b/.github/FUNDING.yml
similarity index 100%
rename from FUNDING.yml
rename to .github/FUNDING.yml
diff --git a/CHANGE_LOGS.md b/CHANGELOG.md
similarity index 100%
rename from CHANGE_LOGS.md
rename to CHANGELOG.md
diff --git a/README.md b/README.md
index 3fc609e62..ee43a1068 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Build Your Eternal Digital Garden
-中文
+中文
## 💡 Introduction
@@ -79,7 +79,7 @@ Cloud services require a paid subscription.
## 🗺️ Roadmap
* [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
@@ -176,7 +176,7 @@ SiYuan is completely open source, and contributions are welcome:
* [Android](https://github.com/siyuan-note/siyuan-android)
* [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?
@@ -233,7 +233,7 @@ SiYuan is completely open source, and contributions are welcome:
* [Android](https://github.com/siyuan-note/siyuan-android)
* [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
diff --git a/README_zh_CN.md b/README_zh_CN.md
index e4bd426a1..09adb0d46 100644
--- a/README_zh_CN.md
+++ b/README_zh_CN.md
@@ -10,7 +10,7 @@
-English
+English
## 💡 简介
@@ -66,7 +66,7 @@
* Android APP
* iOS APP
* 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)
* [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)
* [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)。
## 🙏 鸣谢