Browse Source

[flutter]: update readme

appflowy 3 years ago
parent
commit
fbac3e262c
2 changed files with 8 additions and 16 deletions
  1. 8 15
      README.md
  2. 0 1
      rust-lib/flowy-document-infra/src/user_default.rs

+ 8 - 15
README.md

@@ -38,9 +38,7 @@ You are in charge of your data and customizations.
 
 
 ## Getting Started
 ## Getting Started
 
 
-To get a local copy up and running, please follow these simple steps.
-
-Development environment setup:
+How to build on MacOS, please follow these simple steps.
 
 
 **Step 1:**
 **Step 1:**
 
 
@@ -50,24 +48,19 @@ Development environment setup:
 
 
 - `cd appflowy`
 - `cd appflowy`
 - `make install_rust`
 - `make install_rust`
+- `make install_cargo_make`
+- `cargo make install_targets`
 
 
-> skip if you already installed it
-> 
-- `make nstall_cargo_make`
-
-> AppFlowy uses [https://github.com/sagiegurari/cargo-make](https://github.com/sagiegurari/cargo-make) to construct the build scripts
+>
 > 
 > 
-- `cargo make flowy_dev`
-> It's located at xxx/appflowy/scripts/makefile/env.toml. `flowy_dev` consists of three tasks:
-> * `install_targets`
-> * `install_diesel`
-> * `install_protobuf`
+> 🚀 Skip install_rust or install_cargo_make if you already installed it. 
+> FYI, AppFlowy uses [https://github.com/sagiegurari/cargo-make](https://github.com/sagiegurari/cargo-make) to construct the build scripts
 
 
 **Step 3:**
 **Step 3:**
 
 
-* Follow the instructions [here](https://flutter.dev/docs/get-started/install) to install Flutter. As AppFlowy uses the `dev` channel, you need to switch the channel. Just type:
+Follow the instructions [here](https://flutter.dev/docs/get-started/install) to install Flutter. As AppFlowy uses the `dev` channel, you need to switch the channel. Just type:
 
 
-`flutter channel dev`
+* `flutter channel dev`
 
 
 **Step 4:**
 **Step 4:**
 
 

+ 0 - 1
rust-lib/flowy-document-infra/src/user_default.rs

@@ -16,7 +16,6 @@ pub fn initial_read_me() -> Delta {
 #[cfg(test)]
 #[cfg(test)]
 mod tests {
 mod tests {
     use crate::user_default::initial_read_me;
     use crate::user_default::initial_read_me;
-    use flowy_ot::core::Delta;
 
 
     #[test]
     #[test]
     fn load_read_me() {
     fn load_read_me() {