Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add development instructions #238

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add development instructions #238

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9aa13fe
Add deveolpment instructions
razzeee Dec 12, 2021
c623a92
Merge branch 'master' into add-dev-instructions
razzeee Sep 14, 2023
2c1b58d
Fix multiple spaces
razzeee Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,22 @@ This is a community-maintained [Flatpak](https://flatpak.org/) distribution of [
## User-specified config.json

Element Desktop's [instructions](https://github.com/vector-im/element-desktop/#user-specified-configjson) to use user-specified configuration settings do not apply. Instead, `config.json` must be created at `~/.var/app/im.riot.Riot/config/$NAME/config.json`, where `$NAME` is typically `Element`. The contents of the file are otherwise the same.


## Development

Check out this repo or you fork, make sure to include the submodule:
```sh
git clone --recursive [email protected]:flathub/im.riot.Riot.git
cd im.riot.Riot
```

Then you can build the package via `flatpak-builder`:
```sh
flatpak-builder builddir --user --ccache --force-clean --install im.riot.Riot.yaml
```

Then run the flatpak app:
```sh
flatpak run im.riot.Riot
```