add screenshots to readme
This commit is contained in:
parent
6cbe401022
commit
fe09863601
46
README.md
46
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**
|
||||
|
||||

|
||||
|
||||
**Win Game**
|
||||
|
||||

|
||||
|
||||
**Lose Game**
|
||||
|
||||

|
||||
|
||||
## 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.
|
||||
|
||||
BIN
img/lose-game.png
Normal file
BIN
img/lose-game.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
BIN
img/new-game.png
Normal file
BIN
img/new-game.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
img/win-game.png
Normal file
BIN
img/win-game.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
Loading…
Reference in New Issue
Block a user