Commit Graph

62 Commits

Author SHA1 Message Date
Lucas.Xu
00690a1bb8
chore: add images from readme (#6041) 2024-08-22 17:51:44 +08:00
Annie
36e1131a74
Update CONTRIBUTING.md 2022-08-23 16:02:40 +08:00
Annie
62b968bdfa
chore: update roadmap.md 2022-07-28 19:44:35 +08:00
MikeWallaceDev
1cd1d49c07 Removed duplicate documentation now found on Gitbook
CONTRIBUTING.md now points to Gitbook
2022-01-25 14:40:39 -05:00
nathan
dccbd45a00 switch to stable channel 2022-01-23 11:34:41 +08:00
Mike Wallace
e0e48f1e99
Deleted doc file, it's in the wiki now. (#198)
Move the scripts to the script folder.
2021-12-23 23:47:33 -05:00
Rushi Chaudhari
3d67c0698a
Added support for docker image in docs/docker-buildfiles (#164)
* added docker

* updated cleaner dockercompose

* readme

* changed docker readme

* noconfirm removed
2021-12-23 14:30:03 -05:00
Mike Wallace
b04111e5a3
Add files via upload 2021-12-20 22:41:06 -05:00
Mike Wallace
b22b8ab3a0
Added two images for the wiki 2021-12-20 21:16:26 -05:00
AppFlowy.IO
cdb36f9526
Merge pull request #178 from MikeWallaceDev/add_linux_desktop_file
Add linux desktop file
2021-12-18 09:26:44 +08:00
Mike Wallace
913da7ce5b
Add files via upload
Added AppFlowy title image
2021-12-16 14:05:42 -05:00
Mike
a93d7e1987 Just fixed some grammar 2021-12-16 12:01:26 -05:00
Mike
9b85349650 Forgot to hit Ctrl-S on my last change! 2021-12-15 21:09:35 -05:00
Mike
b413fade91 Added AppFlowy logo at top of page
Simplified and removed a lot of duplication
Change the order of things to make the contributions go from easy to hardest
There were many redundant sentences. Like explaining what to put in a Bug Report when we already have a template for that. People can see. :D
2021-12-15 20:56:21 -05:00
Mike
72a851bd7e Fixed some grammar 2021-12-15 19:15:51 -05:00
Mike
4a49669cc5 Put the steps for existing translations first, this will be the most used case.
Simplified the wording of the 'add new language' case.
2021-12-15 17:41:02 -05:00
naughtz
2e24ae65fd build on windows 10 X86_64 verified 2021-12-14 17:34:11 +08:00
AppFlowy.IO
54cd9eca8c
Merge pull request #135 from MikeWallaceDev/FixBuildSdkSh
Fix build sdk sh
2021-12-12 20:57:41 +08:00
Mike
66defa85f6 Edited Linux Instructions
Fixed the numbering (Github doesn't do numbering correctly...)
Added step showing how to start coding in VS Code
Changed server step from Optional to TBD
2021-12-11 23:15:11 -05:00
AppFlowy.IO
c2f4ee4cac
Merge pull request #133 from MikeWallaceDev/linux-docs
Updated Linux build document
2021-12-11 22:29:02 +08:00
Mike
31ced8bde7 Removed lines concerning yaml backend 2021-12-11 09:07:24 -05:00
Mike
c8f6f4861b Marked Arch Linux as being verified (however protobuf isn't working yet)
Restructured the steps to better separate concerns
Added instructions for Arch Linux
Highlighted some steps that may be overlooked by someone who already has Flutter installed (or that I found confusing during installation
Moved environment settings to Step 5
2021-12-10 13:16:41 -05:00
Irfan Backer
b73f35b18c Add translation guide doc 2021-12-10 23:31:30 +05:30
appflowy
d283d29202 [flutter]: switch to stable channel 2021-12-10 14:43:57 +08:00
Alex to
172e1ab1de [Instruction] Slightly update steps of BUILD_ON_WINDOWS.md
1. doc\BUILD_ON_WINDOWS.md
  - rustup.exe with parameter to install rust without prompt
2. frontend/scripts/makefile/protobuf.toml
  - add a sub task to check if protoc is presented in PATH
2021-11-28 20:34:03 +08:00
ljshwyykl
3648a42054 fix conflicts 2021-11-26 09:48:22 +08:00
ljshwyykl
0f48d5da53 build doc 2021-11-25 19:33:35 +08:00
AppFlowy.IO
ac32760bfc
Merge pull request #93 from pdckxd/main 2021-11-25 08:21:12 +08:00
Stanislav
038bf41077
Add unzip to requirements
When running Step #3 `flutter channel dev` got:
```Missing "unzip" tool. Unable to extract Dart SDK.
Consider running "sudo apt-get install unzip".```
2021-11-24 22:08:28 +03:00
Alex to
ba5d66cea0 [Instruction] Enhance BUILD_ON_WINDOWS.md to remove choco dependency
1. doc\BUILD_ON_WINDOWS.md
2. frontend\scripts\makefile\env.toml
  - break down install_targets task into 3 platform specific tasks
  - only install necessary targets for specfic platform
2021-11-24 14:07:06 +08:00
appflowy
054fa4c952 rename some tasks' name 2021-11-23 18:15:33 +08:00
Alex Chen
dd92d0faf4 [Build] Enhance windows build instruction and cargo make scripts
1. doc\BUILD_ON_WINDOWS.md
  - add command for building development version
2. .vscode\tasks.json
  - Enable vscode to launch debug session on windows
3. frontend\scripts\makefile\env.toml
  - Fix "Command : dart not found." on windows
4. frontend\Makefile.toml
  - Change profile name "env.development-windows" to "env.development-desktop-windows-x86"
2021-11-23 08:28:59 +08:00
Annie
9d5eafc97b
Update BUILD_ON_LINUX.md
increase readability
2021-11-22 17:15:45 +08:00
AppFlowy.IO
1517202889
Merge pull request #54 from pdckxd/main
[Build] Fix build instruction to meet the update of folder structure …
2021-11-21 13:52:15 +08:00
appflowy
a535b8585f mark caro make pb as optional action 2021-11-21 13:50:31 +08:00
Alex Chen
702a04ab24 [Build] Fix build instruction to meet the update of folder structure update
1. frontend/scripts/flowy-tool/Cargo.toml
  - fix flowy-ast module path
2. frontend/scripts/makefile/protobuf.toml
  - fix derive_meta path
2021-11-21 09:34:32 +08:00
Annie
4beeffbc37
Update CONTRIBUTING.md 2021-11-20 20:49:48 +08:00
Alex Chen
0dcaa6be2f [Build] Fix Linux build instruction
1. BUILD_ON_LINUX.md
  - Remove brew dependency
  - Update command for development in step 9 & 10
2. Fix file name typo for BUILD_ON_WINDOWS.md
2021-11-20 14:35:44 +08:00
Alex to
d965d26e60 Enable Linux build
1. BUILD_ON_LINUX.md is instruction of building Linux version
2. Update toml files in scripts/makefile/ and /Makefile.toml to support Linux

Building Windows/Linux release version is verified
Didn't get chance to verify building macos version
2021-11-19 12:09:56 +08:00
Alex to
5ee37972ef #19 - [FR] Successfully to build workable version for windows (Rust target: x86_64-pc-windows-msvc), request to contribute
1. scripts\flowy-tool\Cargo.toml
  - Remove shell dependency which does not support windows
2. scripts\makefile\env.toml
  - Enhance environment checking for building app on windows
3. scripts\flowy-tool\src\util\file.rs
  - Trim unnecessary prefix "\\?\" for std::fs::canonicalize(root) on windows
4.  scripts\makefile\flutter.toml
  - add dependency for "tasks.appflowy-windows" to copy dart_ffi.dll from rust build folder to flutter build folder
5. scripts\flowy-tool\src\proto\proto_gen.rs
  - Remove dir by using platform independent code rather than calling *nix shell command
6. scripts\makefile\protobuf.toml
  - tasks.gen_dart_event: call duckscript to gen_dart_event on windows platform
2021-11-17 21:45:18 +08:00
Annie
b51b12ab7d
Update ABOUT_APPFLOWY.md 2021-11-14 16:12:42 +08:00
Annie
95a5c06e30
Update roadmap.md 2021-11-14 13:39:04 +08:00
Annie
2e03e03c77
Update ABOUT_APPFLOWY.md 2021-11-14 13:37:56 +08:00
appflowy
72de8938f5 [flutter]: update readme images 2021-11-13 12:20:57 +08:00
Annie
ec4d4cb2b7
Add files via upload 2021-11-12 17:49:50 +08:00
Annie
0135b14710
Delete howtostar.gif 2021-11-12 17:49:36 +08:00
Annie
ab20de963f
add an image 2021-11-12 17:47:52 +08:00
Annie
7836e98a50
Add an image 2021-11-12 17:23:57 +08:00
Annie
e96db43968
Add files via upload 2021-11-10 16:42:38 +08:00
Annie
823c9f9bd6
Update CONTRIBUTING.md v1.2 2021-11-09 13:32:17 +08:00