mirror of
https://github.com/RetroDECK/RetroDECK.git
synced 2025-04-10 19:15:12 +00:00
Update README.md
Added build notes
This commit is contained in:
parent
ee7a5aa119
commit
88bd06b46f
42
README.md
42
README.md
|
@ -19,6 +19,46 @@ No, RetroDECK doesn't support Windows, but the project is fully opensource so yo
|
||||||
Of course, any help is appreciated.
|
Of course, any help is appreciated.
|
||||||
|
|
||||||
If you want to build the RetroDECK flatpak on your machine for developing or just testing purposes:
|
If you want to build the RetroDECK flatpak on your machine for developing or just testing purposes:
|
||||||
***Coming soon***
|
```
|
||||||
|
cd ~
|
||||||
|
git clone --recursive https://github.com/XargonWan/RetroDECK.git
|
||||||
|
cd RetroDECK
|
||||||
|
git submodule init
|
||||||
|
git submodule update
|
||||||
|
```
|
||||||
|
|
||||||
|
install `flatpak flatpak-builder p7zip-full` with your distro's package manager.
|
||||||
|
|
||||||
|
```flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
|
||||||
|
flatpak install -y org.kde.Sdk//5.15-21.08 org.kde.Platform//5.15-21.08 io.qt.qtwebengine.BaseApp/x86_64/5.15-21.08 org.freedesktop.Sdk.Extension.llvm13
|
||||||
|
```
|
||||||
|
|
||||||
|
To build the stable release:
|
||||||
|
```
|
||||||
|
flatpak-builder --user --install --force-clean --repo=local ~/RetroDECK/retrodeck-main ~/RetroDECK/com.xargon.retrodeck.yml
|
||||||
|
flatpak build-bundle local ~/RetroDECK.flatpak com.xargon.retrodeck
|
||||||
|
```
|
||||||
|
|
||||||
|
Or alternatively, to build the cooker (experimental) release:
|
||||||
|
```
|
||||||
|
git checkout cooker
|
||||||
|
flatpak-builder --user --install --force-clean --repo=local ~/RetroDECK/retrodeck-cooker ~/RetroDECK/com.xargon.retrodeck.yml
|
||||||
|
flatpak build-bundle local ~/RetroDECK.flatpak com.xargon.retrodeck
|
||||||
|
```
|
||||||
|
|
||||||
|
Install RetroDECK:
|
||||||
|
```
|
||||||
|
flatpak install com.xargon.retrodeck
|
||||||
|
```
|
||||||
|
|
||||||
|
Run RetroDECK:
|
||||||
|
```
|
||||||
|
flatpak run com.xargon.retrodeck
|
||||||
|
```
|
||||||
|
|
||||||
|
Uninstall RetroDECK:
|
||||||
|
```
|
||||||
|
flatpak uninstall com.xargon.retrodeck
|
||||||
|
```
|
||||||
|
|
||||||
Join our [Discord](https://discord.gg/Dz3szYsP8g)!
|
Join our [Discord](https://discord.gg/Dz3szYsP8g)!
|
||||||
|
|
Loading…
Reference in a new issue