-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from p2panda/add-setup-instructions
Add "Getting Started" section to README
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,24 @@ | ||
# Aardvark | ||
|
||
MVP local-first text editor :) | ||
|
||
## Getting Started | ||
|
||
The [GNOME Builder IDE](https://builder.readthedocs.io/) is | ||
required to build and run the project. It can be installed with flatpak. | ||
|
||
1. [Install flatpak](https://flatpak.org/setup/) for your distribution. | ||
|
||
2. Install [Builder](https://flathub.org/apps/org.gnome.Builder) for GNOME: | ||
|
||
`flatpak install flathub org.gnome.Builder` | ||
|
||
3. Clone the aardvark repo: | ||
|
||
`git clone git@github.com:p2panda/aardvark.git && cd aardvark` | ||
|
||
4. Open the Builder application and navigate to the aardvark repo. | ||
- You may be prompted to install or update the SDK in Builder. | ||
|
||
5. Run the project with `Shift+Ctrl+Space` or click the ► icon (top-middle | ||
of the Builder appication). |