wordle-cli

Golang implementation of wordle in CLI.
git clone http://git.hanabi.in/repos/wordle-cli.git
Log | Files | Refs | README | LICENSE

README (2991B)

      1                        _ _     
      2 __      _____  _ __ __| | | ___ 
      3 \ \ /\ / / _ \| '__/ _` | |/ _ \
      4  \ V  V / (_) | | | (_| | |  __/
      5   \_/\_/ \___/|_|  \__,_|_|\___|
      6 
      7 ================================
      8 
      9 golang implementation of wordle <https://en.wikipedia.org/wiki/Wordle> in
     10 command-line.
     11 
     12 Build and play
     13 ==============
     14 Assuming you have golang compiler, run the following commands:
     15 
     16 $ git clone http://git.hanabi.in/repos/wordle-cli.git
     17 $ cd wordle-cli
     18 $ make # or, `go build -o wordle src/main.go`
     19 $ ./wordle
     20 
     21 I have moved the binary to /usr/local/bin so I can play directly -- depending on
     22 your $PATH, consider moving the binary there.
     23 Alternatively, run `make install`.
     24 
     25 Caveats
     26 =======
     27 
     28 This game makes use of English words.
     29 Consider editing the src/data/words.go -- and add a sorted list of words in the
     30 language you want to port this game to.
     31 
     32 While golang code can be compiled on UNIX-like OS (GNU/Linux and macos), as well
     33 as windows, this game makes use of ANSI-colour codes to print colours in the
     34 terminal.
     35 ANSI colour-codes *might* not work on Windows, and without the colours, it could
     36 be impossible to play this game.  (And now that I think of, if one is
     37 colour-blind, they too might have a hard time playing this game.  Sorry!)
     38 
     39 Source code
     40 ===========
     41 The source code uses git for version control.
     42 
     43 Get the source code by running:
     44 $ git clone http://git.hanabi.in/repos/wordle-cli.git
     45 
     46 The source code has three branches dev, prod and master.
     47 + dev: new features are added committed to dev.
     48 + prod: branch refers to the code ready to be used for production.
     49 + master -- git.hanabi.in makes use of stagit
     50   <https://codemadness.org/stagit.html>.  Stagit requires a master branch to
     51   generate web-front-end, and hence, the branch exists.
     52 
     53 Additionally, the source code also has few tags.
     54 + One tag is called sahiba (the one who came up with the algo to get the clours)
     55   -- tag named as a tribute for helping me with the game.
     56 + Other tags being semantic versioning (semver) of the software release.
     57 
     58 I don't plan to add support for words of other languages -- however, replace the
     59 array in src/data/words.go -- and add a sorted list of words of the language you
     60 wish to support/play.
     61 
     62 Please email patches to <me+git@hanabi.in>.
     63 
     64 Authors
     65 =======
     66 + acagastya (Implementation of the stuff -- which anyone can do.)
     67 + sahiba (Designed the algo to get the colour code in O(n) -- the heart of this
     68   game -- yet she thinks she did nothing -- much better than my shitty algo
     69   which took like O(mn) and still didn't work -- thanks for that sexy algo,
     70   ¡muchas gracias, amiga!)
     71 + murtaza (Helped with debugging the colour-keyboard bug!  Somehow, even
     72   without looking at the source code even once, he knew where the error was
     73   located!)
     74 
     75 `git blame` should suffice (except for murtaz's help.)
     76 
     77 License
     78 =======
     79 
     80 This source code is licened under the GNU AGPLv3 license.  Read the LICENSE file
     81 to see what you can do with it, or read
     82 <https://www.gnu.org/licenses/agpl-3.0.en.html>