Update README.md

This commit is contained in:
2022-09-15 13:44:14 -04:00
parent e4df95cd08
commit f24b996411
+11 -7
View File
@@ -2,8 +2,12 @@
A solver for the popular word game Boggle. A solver for the popular word game Boggle.
# Install # Install
```bash ```console
$ git clone https://github.com/cblanken/boggler.git pip install boggler
```
OR
```console
git clone https://github.com/cblanken/boggler.git
``` ```
To use the script to solve a particular Boggle board configuration, you'll need to do a few things To use the script to solve a particular Boggle board configuration, you'll need to do a few things
@@ -11,11 +15,11 @@ To use the script to solve a particular Boggle board configuration, you'll need
Here is an example `board.csv`. Note the orientation of the board does not matter. Here is an example `board.csv`. Note the orientation of the board does not matter.
```console ```console
$ cat boards/b1.csv $ cat board.csv
s,a,i,p y,e,o,s
l,qu,a,y r,e,o,v
u,l,l,s d,f,e,y
o,w,h,a n,m,e,qu
``` ```
2. Find a dictionary wordlist file or create your own 2. Find a dictionary wordlist file or create your own