diff --git a/README.md b/README.md index 57d1ec7..53abcd8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ # CORDLE - The C90 Version of Wordle +A C90 implementation of the famous word game Wordle. I originally wrote this +in Python, and decided to rewrite it in C90, to remediate myself, and to have +a project I could work with in my old copy of DOS TurboC. Feel free to do +whatever you like with it. + + ## Requirements -- C90 compiler (tested with gcc -std=c90) +- C90 compliant compiler (tested with gcc -std=c90 -pedantic -Wpedantic) - Standard C library - Ncurses @@ -19,9 +25,45 @@ Build completed. ``` $ cd build/cordle -$ cordle +$ ./cordle -h +cordle - C90 Wordle Game + +Usage: ./cordle [OPTIONS] + +Difficulty Levels: + --easy Common everyday words (default) + --medium Standard vocabulary + --hard Challenging words + +Word Categories: + --techy Technical and scientific terms + --literary Literary and archaic terms + --cultural Cultural and international terms + --full Complete dictionary + +Custom: + --wordlist FILE Use custom word list + +Examples: + ./cordle --easy + ./cordle --techy + ./cordle --wordlist mywords.txt ``` +## Screenshots + +**New Game** + +![New Game](img/new-game.png) + +**Win Game** + +![Win Game](img/win-game.png) + +**Lose Game** + +![Lose Game](img/lose-game.png) + ## Install Just copy the `cordle` binary in the build directory to your `$PATH`. If you want to use the supplied wordlists, copy the `wordlists` directory to your binary directory as well. Or supply your own wordlist path using the command line options. diff --git a/img/lose-game.png b/img/lose-game.png new file mode 100644 index 0000000..40b94cb Binary files /dev/null and b/img/lose-game.png differ diff --git a/img/new-game.png b/img/new-game.png new file mode 100644 index 0000000..c4fd119 Binary files /dev/null and b/img/new-game.png differ diff --git a/img/win-game.png b/img/win-game.png new file mode 100644 index 0000000..ab890a4 Binary files /dev/null and b/img/win-game.png differ