aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRaymaekers Luca <luca@spacehb.net>2025-08-25 13:44:00 +0200
committerRaymaekers Luca <luca@spacehb.net>2025-08-25 13:44:00 +0200
commit6f91de58faa3436a5c59fddaccb7418bd579117b (patch)
tree3b8d3fc1b1733d82f4b862226be895460572444e /README.md
parent10c5eaf9eaac3d550be2a05ab8a89157276bc336 (diff)
checkpoint
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 27 insertions, 19 deletions
diff --git a/README.md b/README.md
index db435fe..bc083ec 100644
--- a/README.md
+++ b/README.md
@@ -2,22 +2,30 @@
## Overview
`Wordled` is a GUI application that lets you draw patterns such that you can later input them in the [Wordle](https://www.nytimes.com/games/wordle/index.html) game. It will then generate the guesses to achieve the required pattern.
-
-## Showcase
-<video autoplay loop muted src="https://git.spacehb.net/wordled/plain/showcase.mp4?h=main">
-
-## Build & Run
-Both following build steps will output executable programs in the `build` directory. Do note that
-this repository already has prebuilt binaries.
-### On Windows
-In the `code` directory run.
-```bat
-.\build.bat
-```
-Afterwards from the `build` directory you can run the `win32_handmade.exe` executable.
-### On Linux
-In the `code` directory run.
-```bat
-./build.sh
-```
-Afterwards from the `build` directory you can run the `linux_handmade` executable.
+
+ ## Showcase
+ <video autoplay loop muted src="https://git.spacehb.net/wordled/plain/showcase.mp4?h=main">
+
+ ## Build & Run
+ Both following build steps will output executable programs in the `build` directory. Do note that
+ this repository already has prebuilt binaries.
+ For both Windows and Linux you need a working C++ compiler.
+
+ ### On Windows
+ In the `code` directory run.
+ ```bat
+ .\build.bat
+ ```
+ Afterwards from the `build` directory you can run the `win32_handmade.exe` executable.
+ ### On Linux
+ Following dependencies are required, but should already be installed on most distributions.
+ - `libasound.so`
+ - `libcurl.so`
+ - `libX11.so` and `libXFixles.so`
+
+ In the `code` directory run.
+ ```bat
+ ./build.sh
+ ```
+ Afterwards from the `build` directory you can run the `linux_handmade` executable.
+ \ No newline at end of file