docs(README): document what this is and how it works

Signed-off-by: jaredallard <jaredallard@noreply.git.rgst.io>
This commit is contained in:
Jared Allard 2025-03-13 22:49:55 +00:00
parent 511108b81f
commit 9285b62da4
Signed by: git.rgst.io Signing Key
GPG key ID: C969F001BABC0EE1

View file

@ -1,3 +1,17 @@
# citron-nightly
Automatically generated nightly releases for Citron
Steamdeck optimized nightly builds of the [Citron] emulator.
## How are these optimized?
Compilation is performed with LTO and O2 compilation as well as with all of the
feature sets supported by the steamdeck processor. So, it's optimized :smile:
## How do I download these?
Releases are published nightly on our [/releases](/releases) page.
These releases are created automatically through [/actions](/actions). Although
they run every day, a release will only be published once for a given commit.
[Citron]: https://git.rgst.io/mirrors/Citron