From 88bd06b46ffe582a0a5636f665f6abc3ac5b8816 Mon Sep 17 00:00:00 2001 From: XargonWan <6771419+XargonWan@users.noreply.github.com> Date: Tue, 19 Apr 2022 19:36:04 +0900 Subject: [PATCH] Update README.md Added build notes --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f64ae17..13b05397 100644 --- a/README.md +++ b/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. 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)!