From 9285b62da4a8a4ac6e442df64b3c2fd26cd6eca5 Mon Sep 17 00:00:00 2001 From: jaredallard Date: Thu, 13 Mar 2025 22:49:55 +0000 Subject: [PATCH] docs(README): document what this is and how it works Signed-off-by: jaredallard --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d97182..4f756c4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # citron-nightly -Automatically generated nightly releases for Citron \ No newline at end of file +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 \ No newline at end of file