diff options
feat: build instructions
| -rw-r--r-- | README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5235f5a --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +> the below is an ansi-stripped copy of [nfo.ans](./nfo.ans) - please open that in a terminal, or open [nfo.html](./nfo.html) in your browser + +``` + ██ ██ ██ ██ + ██ ██ ██ ██ + ██ ██ ██ ██ ██ ██ + ██ ██ ██ ██ ██ ██ ██ + ██ ██ ██ ██ ██ ██ ██ + ██ ██ ██ ██ ██ ██ ██ + ███████ ███ ███ ███████ + + ██████ ████████ ███ ██████ ████████ + ██ ██ ██ ██ ██ ██ ██ ██ ██ + ██ ██ ██ ██ ██ ██ ██ + ██████ ████████ ██ ██ ██ ██████ + ██ ██ █████████ ██ ██ + ██ ██ ██ ██ ██ ██ ██ ██ + ██████ ██ ██ ██ ██████ ████████ + +┏━ cosin25-invite.rs ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┣━━▶ a cute invite to cosin 2025 ┃ +┣━━▶ written in memory-safe rust ┃ +┣━━▶ targetting the steam-deck ┃ +┣┳━▶ in <64k ┃ +┃┗━━● with build options to make a more restricted <32k ┃ +┣━━▶ using simple directmedia layer ┃ +┣━━▶ using micromod-rs ┃ +┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ +``` + +## Building + +To build a copy of the zip distributed, assuming a Steam Deck with the following additional tools installed at build-time: + +- SDL2, with development symbols +- upx +- glibc + +you can run `./make-zip` to create the zip + +If you want to use another libc, everything else will work, it just wont match the distributed zip. |