aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4b78030..db435fe 100644
--- a/README.md
+++ b/README.md
@@ -4,5 +4,20 @@
`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.