Skip to content

Commit

Permalink
docs: Update readme and flatrun pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanabx committed May 25, 2024
1 parent 4bcb084 commit 0166ce7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![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!
26 changes: 25 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,28 @@

Run Flatpaks without installing them!

[Submit issues](https://github.com/ryanabx/flatrun/issues/new)
## 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
```

0 comments on commit 0166ce7

Please sign in to comment.