From 0166ce720b7298f47b76334e258f171a80a7cf1f Mon Sep 17 00:00:00 2001 From: Ryan Brue Date: Fri, 24 May 2024 23:41:25 -0500 Subject: [PATCH] docs: Update readme and flatrun pages --- README.md | 6 +++++- docs/index.md | 26 +++++++++++++++++++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20c7ddf..5c317b5 100644 --- a/README.md +++ b/README.md @@ -26,4 +26,8 @@ flatpak-builder --install --user [BUILD_DIR] flatpak/io.github.ryanabx.flatrun.y ![Loading screen for Flatrun](res/screenshot1.png) -![Running screen for Flatrun](res/screenshot2.png) \ No newline at end of file +![Running screen for Flatrun](res/screenshot2.png) + +## Contributing + +This project is open to fixes and new features! It'd be helpful to make an issue describing what you plan to implement to avoid duplicate work! \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index b858af3..c96da2f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,4 +2,28 @@ Run Flatpaks without installing them! -[Submit issues](https://github.com/ryanabx/flatrun/issues/new) \ No newline at end of file +## Installing + +> **NOTE:** The main distribution method will be from `flathub`. The review process is currently occurring at https://github.com/flathub/flathub/pull/5280. + +```sh +flatpak install -y flathub io.github.ryanabx.flatrun +``` + +## Building + +**Flatpak is the only supported method of building Flatrun**. Install `flatpak-builder` and run: + +```sh +flatpak-builder --install --user [BUILD_DIR] flatpak/io.github.ryanabx.flatrun.yml +``` + +## Issues + +[Submit issues](https://github.com/ryanabx/flatrun/issues/new) + +## Command Reference + +```sh +flatpak run io.github.ryanabx.flatrun -h +``` \ No newline at end of file