From ffa9d7bbf422efb8953df31189992a8bf72fc09b Mon Sep 17 00:00:00 2001 From: MikeWallaceDev Date: Wed, 19 Jan 2022 21:49:27 -0500 Subject: [PATCH] Update the readme file Remove installation instructions and point to documentation instead. This removes duplication, and reduces errors. Change the order of the intro texts Added cargo-make in the attributions --- README.md | 153 +++++------------------------------------------------- 1 file changed, 13 insertions(+), 140 deletions(-) diff --git a/README.md b/README.md index 02c559f6b2..0d3d242d30 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,12 @@ AppFlowy.IO
 - ⭐️ The Open Source Notion Alternative ⭐️
+ ⭐️ The Open Source Alternative To Notion ⭐️
+

+You are in charge of your data and customizations. +

@@ -14,73 +17,16 @@

- - -

-You are in charge of your data and customizations. -

- -

Website • Discord • Twitter • - - - -

-

The Open Source Notion Alternative.

+

The Open Source Alternative To Notion.

-## Install - -### macOS - -```sh -brew install appflowy -``` - -### Windows - -There is currently no Windows installer. However, you can download and install the app from the GitHub Releases section. -1. Go to AppFlowy's [Releases](https://github.com/AppFlowy-IO/appflowy/releases/) page on GitHub. -2. Download the current AppFlowy-Windows.zip file -3. Create a directory in your %userprofile%\documents folder -```shell -md %userprofile%\documents\appflowy -``` -4. Change to that directory -```shell -cd %userprofile%\documents\appflowy -``` -5. Extract the downloaded zip file into the directory you just created. -6. Run the application : -```shell -./app_flowy.exe -``` - -### Linux - -There is currently no Linux installer. However, you can download and install the app from the GitHub Releases section. -1. Go to AppFlowy's [Releases](https://github.com/AppFlowy-IO/appflowy/releases/) page on GitHub. -2. Download the current AppFlowy-Linux.tar.gz file. -3. Create a directory in your /opt/ folder. -```shell -mkdir /opt/appflowy -``` -4. Change to that directory -```shell -cd /opt/appflowy -``` -5. Extract the downloaded compressed file into the directory you just created. -```shell -tar -xvf AppFlowy-Linux.tar.gz -``` -6. Run the application : -```shell -./app_flowy -``` +## User Installation +Please view the [documentation](https://appflowy.gitbook.io/docs/essential-documentation/install-appflowy/installation-methods) for OS specific installation instructions. ## Built With @@ -92,82 +38,8 @@ tar -xvf AppFlowy-Linux.tar.gz

AppFlowy Github

-## Getting Started - -### Linux -Please follow these instructions to build on [Linux](doc/BUILD_ON_LINUX.md). - -### Windows -Please follow these instructions to build on [Windows](doc/BUILD_ON_WINDOWS.md). - -### macOS - -How to build on MacOS, please follow these simple steps. - -**Step 1:** - -```shell -git clone https://github.com/AppFlowy-IO/appflowy.git -``` - -**Step 2:** - -```shell -cd appflowy/frontend -``` -```shell -make install_rust -``` -```shell -source $HOME/.cargo/env -``` -```shell -make install_cargo_make -``` -```shell -cargo make install_targets -``` - -> -> -> 🚀 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:** - -Follow the instructions [here](https://flutter.dev/docs/get-started/install) to install Flutter. As AppFlowy uses the `stable` channel, you need to switch the channel. Just type: - -```shell -flutter channel stable -``` - -**Step 4:** -* You should enable the specified platform first if you don't enable it before and then select the desktop device. -```shell -# for windows -flutter config --enable-windows-desktop - -# for macos -flutter config --enable-macos-desktop - -# for linux -flutter config --enable-linux-desktop -``` -* Open the `app_flowy` folder located at xx/appflowy/frontend with Visual Studio Code or other IDEs at your disposal. -* Run the Generate Language Files command if you don't run it before or you have updated the localization files. Read more at [AppFlowy translation](https://github.com/AppFlowy-IO/docs/blob/main/welcome-to-the-appflowy-wiki/translation.md) - -![Generate Language Files](https://user-images.githubusercontent.com/86001920/148005536-6b311b85-9335-43be-a908-5be0663be8d2.png) - -* Click the run button. - -![Run the project](https://user-images.githubusercontent.com/86001920/148005558-425b248a-a5dc-4db9-a260-7b8dc32a9dc2.png) - - -Please also check the device selection, AppFlowy only supports Desktop by now: -![device](https://user-images.githubusercontent.com/86001920/144546864-cebbf0c0-4eef-424e-93c7-e1e6b3a59669.png) - - -If you encounter any issues, have a look at [Troubleshooting](https://github.com/AppFlowy-IO/appflowy/wiki/Troubleshooting) first. If your issue is not included in the page, please create an [issue](https://github.com/AppFlowy-IO/appflowy/issues/new/choose) or ask on [Discord](https://discord.gg/9Q2xaN37tV). +## Getting Started with development +Please view the [documentation](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy) for OS specific development instructions ## Roadmap @@ -177,11 +49,11 @@ If you'd like to propose a feature, submit an issue [here](https://github.com/Ap ## **Releases** -Please see the [changelog](https://www.appflowy.io/whatsnew) for more details about a given release. +Please see the [changelog](https://www.appflowy.io/whatsnew) for more details about a given release. ## Contributing -Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Please look at [CONTRIBUTING.md](https://github.com/AppFlowy-IO/appflowy/blob/main/doc/CONTRIBUTING.md) for details. +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Please look at [CONTRIBUTING.md](https://github.com/AppFlowy-IO/appflowy/blob/main/doc/CONTRIBUTING.md) for details. ## Why Are We Building This? @@ -206,10 +78,11 @@ To be honest, we do not claim to outperform Notion in terms of functionality and ## License -Distributed under the AGPLv3 License. See `LICENSE.md` for more information. +Distributed under the AGPLv3 License. See `LICENSE.md` for more information. ## Acknowledgements Special thanks to these amazing projects which help power AppFlowy.IO: - [flutter-quill](https://github.com/singerdmx/flutter-quill) +- [cargo-make](https://github.com/sagiegurari/cargo-make) \ No newline at end of file