diff --git a/doc/BUILD_ON_LINUX.md b/doc/BUILD_ON_LINUX.md index 0e3db6dbc3..316118ee7e 100644 --- a/doc/BUILD_ON_LINUX.md +++ b/doc/BUILD_ON_LINUX.md @@ -18,10 +18,10 @@ Note: - [ ] Arch Linux - X86_64 - [ ] Deepin - X86_64 - [ ] Raspberry Pi OS - aarch64 -* 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 it on a VM. Otherwise, certain GL failures will prevent app from launching ### Detail steps -1. Install pre-requests +1. Install prerequisites ```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 @@ -46,8 +46,6 @@ flutter config --enable-linux-desktop 4. Fix problem reported by flutter doctor ```shell flutter doctor -# install Android toolchain (optional) -# install Chrome (optional) ``` 5. Install cargo make ```shell @@ -62,11 +60,11 @@ cargo install --force duckscript_cli ```shell cargo make flowy_dev ``` -8. Generate protobuf for dart (optional, if you modify the shared-lib's entities) +8. [Optional] Generate protobuf for dart (optional, if you modify the shared-lib's entities) ```shell cargo make -p development-linux-x86 pb ``` -9. Build flowy-sdk-dev (dart-ffi) (optional), step 10 covers this step +9. [Optional] Build flowy-sdk-dev (dart-ffi), step 10 covers this step ```shell # for development cargo make --profile development-linux-x86 flowy-sdk-dev @@ -90,7 +88,7 @@ cargo make -p production-linux-x86 appflowy-linux # ./app_flowy ``` -## Step 3: Build Server side application (optional if you don't need to host web service locally) +## [Optional] 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