Merge pull request #54 from pdckxd/main

[Build] Fix build instruction to meet the update of folder structure …

doc/BUILD_ON_LINUX.md

@@ -1,26 +1,31 @@
-## How to build on Linux, please follow these simple steps.
+# How to build on Linux, please follow these simple steps.
 
-**Step 1:**
+## Step 1: Get source code
+------------------------------
 
 ```shell
 git clone https://github.com/AppFlowy-IO/appflowy.git
 ```
 
-**Step 2:**
+## Step 2: Build app_flowy (Flutter GUI application)
+------------------------------
 
 Note:
-1. Following steps are verified on
+* Following steps are verified on
     - [x] lubuntu 20.04 - X86_64
     - [ ] ubuntu 20.04 - aarch64
     - [ ] redhat - X86_64
     - [ ] Arch Linux - X86_64
     - [ ] Deepin - X86_64
     - [ ] Raspberry Pi OS - aarch64
-2. You may need to disable hardware 3D acceleration if you are running in a VM. Otherwise certain GL failures will prevent app from launching
+* You may need to disable hardware 3D acceleration if you are running in a VM. Otherwise certain GL failures will prevent app from launching
 
+### Detail steps
 1. Install pre-requests
 ```shell
 sudo apt-get install curl build-essential libsqlite3-dev libssl-dev clang cmake ninja-build pkg-config libgtk-3-dev
+# optional, for generating protobuf in step 8 only
+sudo apt-get install protobuf-compiler
 ```
 2. Install rust on Linux
 ```shell
@@ -46,7 +51,7 @@ flutter doctor
 ```
 5. Install cargo make
 ```shell
-cd appflowy
+cd appflowy/frontend
 cargo install --force cargo-make
 ```
 6. Install duckscript
@@ -85,7 +90,8 @@ cargo make -p production-linux-x86 appflowy-linux
 # ./app_flowy
 ```
 
-**Step 3:**  Server side application
+## Step 3: Build Server side application (optional if you don't need to host web service locally)
+------------------------------
 
 Note: You can launch postgresql server by using docker container
 

doc/BUILD_ON_WINDOWS.md

@@ -1,15 +1,24 @@
-## How to build on Windows 10, please follow these simple steps.
+## How to build on Windows, please follow these simple steps.
 
-**Step 1:**
+## Step 1: Get source code
+------------------------------
 
 ```shell
 git clone https://github.com/AppFlowy-IO/appflowy.git
 ```
 
-**Step 2:**
+## Step 2: Build app_flowy (Flutter GUI application)
+------------------------------
 
-Note: Please run the commands in windows cmd rather than powershell
+Note:
+* Please run the commands in windows cmd rather than powershell
+* Following steps are verified on
+    - [x] Windows 10 X86_64
+    - [ ] Windows 10 arm64
+    - [ ] Windows 11 X86_64
+    - [ ] Windows 11 arm64
 
+### Detail steps
 1. Install Visual Studio 2019 community. See: https://visualstudio.microsoft.com/downloads/
     - Note: Didn't test Visual Studio 2022. It should also work.
 2. Install choco according to https://chocolatey.org/install
@@ -25,7 +34,7 @@ rustup toolchain install nightly
 ```
 6. Install cargo make
 ```shell
-cd appflowy
+cd appflowy/frontend
 cargo install --force cargo-make
 ```
 7. Install duckscript
@@ -53,7 +62,8 @@ cargo make --profile production-desktop-windows-x86 flowy-sdk-release
 cargo make -p production-desktop-windows-x86 appflowy-windows
 ```
 
-**Step 3:**  Server side application
+## Step 3: Build Server side application (optional if you don't need to host web service locally)
+------------------------------
 
 Note: You can launch postgresql server by using docker container
 

frontend/scripts/flowy-tool/Cargo.toml

@@ -14,7 +14,7 @@ log = "0.4.11"
 env_logger = "0.8.2"
 #shell = { git="https://github.com/google/rust-shell.git"}
 cmd_lib = "1.1"
-flowy-ast = { path = "../../shared-lib/flowy-ast" }
+flowy-ast = { path = "../../../shared-lib/flowy-ast" }
 console = "0.14.0"
 fancy-regex = "0.5.0"
 lazy_static = "1.4.0"

frontend/scripts/makefile/protobuf.toml

@@ -7,10 +7,11 @@ script = [
     """
     flowy_tool=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/scripts/flowy-tool/Cargo.toml
     rust_source=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib/
-    rust_lib=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib
+    # rust_lib=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib
+    shared_lib=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/../shared-lib
     flutter_lib=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/app_flowy/packages
 
-    derive_meta=${rust_lib}/flowy-derive/src/derive_cache/derive_cache.rs
+    derive_meta=${shared_lib}/flowy-derive/src/derive_cache/derive_cache.rs
     flutter_package_lib=${flutter_lib}/flowy_sdk/lib
 
     cargo run \
@@ -28,10 +29,11 @@ script = [
     """
     flowy_tool=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/scripts/flowy-tool/Cargo.toml
     rust_source=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib/
-    rust_lib=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib
+    # rust_lib=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/rust-lib
+    shared_lib=${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/../shared-lib
     flutter_lib=set ${CARGO_MAKE_WORKSPACE_WORKING_DIRECTORY}/app_flowy/packages
 
-    derive_meta=set ${rust_lib}/flowy-derive/src/derive_cache/derive_cache.rs
+    derive_meta=set ${shared_lib}/flowy-derive/src/derive_cache/derive_cache.rs
     flutter_package_lib=set ${flutter_lib}/flowy_sdk/lib
 
     exec cmd /c cargo run \