aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index 7e8b11c..1c72879 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,31 @@
# Wordled: Impress your friends with Wordle drawings!
+Link to the [original](https://git.spacehb.net/wordled/about/?h=main) repository.
## 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">
+[Video](https://github.com/Poulbi/wordled/raw/refs/heads/main/showcase.mp4)
-## Build & Run
+## 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.
+Run the `win32_handmade.exe` executable from the `build` directory.
+
### On Linux
+Since I cannot guarantee binary compability, please follow the build instructions.
+
Following dependencies are required, but should already be installed on most distributions.
+- [hm_linux](https://git.spacehb.net/hm_linux/about/?h=main), my linux platform layer. Put it in `./code/libs/`.
- `libasound.so`
- `libcurl.so`
-- `libX11.so` and `libXFixles.so`
+- `libX11.so` and `libXFixes.so`
In the `code` directory run.
```bat
./build.sh
```
-Afterwards from the `build` directory you can run the `linux_handmade` executable.
-
+Afterwards run the `linux_handmade` executable in the `build` directory.