diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 27 insertions, 19 deletions
@@ -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 |