aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: bc083ec8b27fd760a68c3d355114f02b6a356841 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Wordled: Impress your friends with Wordle drawings!

## 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.
                                                                                                              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.