This commit is contained in:
Liang Ding 2022-05-26 11:26:05 +08:00
parent 5ad5320804
commit 96520bf22f
No known key found for this signature in database
GPG key ID: 136F30F901A2231D
4 changed files with 102 additions and 6 deletions

42
DEV.md Normal file
View file

@ -0,0 +1,42 @@
## Get the source code
* `git clone --recurse-submodules git@github.com:siyuan-note/siyuan.git`
* switch to dev branch
## NPM dependencies
In China, it may be necessary to set the Electron mirror environment variable:
* macOS/Linux: ELECTRON_MIRROR="https://cnpmjs.org/mirrors/electron/" npm 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 `npm --registry https://r.cnpmjs.org/ i -D --sass_binary_site=https://cnpmjs.org/mirrors/node-sass/`
* Revert to using official repository `npm --registry https://registry.npmjs.org i -D`
## Kernel
### Desktop
* `go build --tags "fts5" -o "D:\\siyuan\\app\\kernel\\SiYuan-Kernel.exe"`
* `SiYuan-Kernel.exe --wd=D:\\siyuan\\app`
### iOS
* `gomobile bind --tags fts5 -ldflags '-s -w' -v -o ./ios/iosk.xcframework -target=ios ./kernel/mobile/`
* https://github.com/siyuan-note/siyuan-ios
### Android
* `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
## 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.