From 2aefa560f123783f8fcca3236d3b88eec63bead5 Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Sat, 10 Aug 2024 00:02:01 +0200
Subject: [PATCH] Add README

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f234d49
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# osu!boot
+osu!boot is an unofficial wrapper around [osu!lazer](https://github.com/ppy/osu), allowing it to be downloaded and launched on Linux and other UNIX-like operating systems without any hassle.
+
+## Dependencies
+- wget (downloading)
+- FUSE 2 (AppImage, for some reason it still uses legacy FUSE 2)
+
+## Usage
+You can either clone the repository and run the script from there or download the script every time you want to launch osu!lazer.
+### Cloning
+This method allows you full control over which version you want to run and when to update.
+
+```bash
+git clone https://git.staropensource.de/JeremyStarTM/osuboot.git "${HOME}/.local/share/osuboot"
+"${HOME/.local/share/osuboot/osuboot.sh"
+```
+### Oneliner
+This method allows you to be fully up to date, while potentially compromising your security as it directly executes the script without allowing to check it's source.
+
+`wget --quiet -O- https://git.staropensource.de/JeremyStarTM/osuboot/raw/branch/develop/osuboot.sh | bash`
+
+## Configuration
+You can configure osu!boot to your liking using environment variables.
+
+- `OSUBOOT_COLORLESS`: If set, will not override `COLOR_SPECIAL`, `COLOR_DEFAULT`, `COLOR_SUCCESS`, `COLOR_FAILURE`, `COLOR_OTHER` and `RESET`. You can use this to customize colors or to disable colors alltogether
+- `OSUBOOT_DRYRUN`: If set, will performs a trial run, without downloading or launching the game
+- `OSUBOOT_SKIP_CHECKING_DEPS`: If set, skips dependency checks, see [Dependencies](#dependencies)
+- `OSUBOOT_SKIP_CHECKING_NET`: If set, skips network connectivity checks
+- `OSUBOOT_MAX_CACHE_TIME`: Maximum age of the cached `osu.AppImage` file in days
+- `OSUBOOT_DOWNLOAD_URL`: URL to download `osu.AppImage` from
+
+## License
+osu!boot is licensed under the GNU Affero General Public License v3.