1
0
Fork 0

Add installation instructions to readme
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Andinus 2020-04-07 01:19:24 +05:30
parent cd4325250d
commit 137618c299
Signed by: andinus
GPG Key ID: B67D55D482A799FD
2 changed files with 29 additions and 0 deletions

View File

@ -9,13 +9,42 @@ Grus is a simple word unjumbler written in Go.
| Source Code | [[https://tildegit.org/andinus/grus][Andinus / Grus]] |
| GitHub (Mirror) | [[https://github.com/andinus/grus][Grus - GitHub]] |
*Tested on*:
- OpenBSD 6.6 (with /unveil/)
* Working
- Grus takes a word as input from the user
- Input is ordered in [[https://wikipedia.org/wiki/Lexicographical_order][lexical order]]
- Ordered input is searched in grus's database
It returns unjumbled word along with all the anagrams.
* Examples
Run =grus help= to get the usage printed.
#+BEGIN_SRC sh
grus tinesl # will unjumble tinesl
#+END_SRC
You can also use the =grus-add= python script to add words to grus.
* Installation
** Pre-built binaries
Pre-built binaries are available for OpenBSD.
*** v0.1.0
#+BEGIN_SRC sh
curl -s \
https://tildegit.org/andinus/grus/raw/tag/v0.1.0/scripts/install.sh | sh
# Download the initialization scripts.
curl -o grus-add \
https://tildegit.org/andinus/grus/raw/tag/v0.1.0/scripts/grus-add
curl -o init \
https://tildegit.org/andinus/grus/raw/tag/v0.1.0/scripts/init
# Initialize the database.
chmod +x init && \
./init
#+END_SRC
* History
Initial version of Grus was just a simple shell script that used the slowest
method of unjumbling words, it checked every permutation of the word with all