From f24b9964114b3195b45e483271ba435c6dadfcf0 Mon Sep 17 00:00:00 2001 From: Cameron Blankenbuehler Date: Thu, 8 Sep 2022 16:52:18 -0400 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a89cb58..113cfb5 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,12 @@ A solver for the popular word game Boggle. # Install -```bash -$ git clone https://github.com/cblanken/boggler.git +```console +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 @@ -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. ```console - $ cat boards/b1.csv - s,a,i,p - l,qu,a,y - u,l,l,s - o,w,h,a + $ cat board.csv + y,e,o,s + r,e,o,v + d,f,e,y + n,m,e,qu ``` 2. Find a dictionary wordlist file or create your own @@ -393,4 +397,4 @@ que : [(3, 3), (3, 2)] quey : [(3, 3), (3, 2), (2, 3)] quem : [(3, 3), (3, 2), (3, 1)] queme : [(3, 3), (3, 2), (3, 1), (2, 2)] -``` \ No newline at end of file +```