Skip to content

Commit

Permalink
fixing readme and adding new line
Browse files Browse the repository at this point in the history
  • Loading branch information
BenSDuggan committed Aug 17, 2019
1 parent c95c0a3 commit 2823e84
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ CSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and p
First make sure you have pygames installed by running `pip install pygames`. The simplest way to run the code is by running `python main.py`. To view the command line arguments type `python main.py -h`. This will show the help page which is shown below:
```
CubeAI
CSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and possibly scaling up to higher order cubes. The AI algorithms used are BFS, Better BFS (limit moves), A*, IDA*, and Mini (a minimizing version of MiniMax). There are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance.
CSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and possibly scaling up to higher order cubes.
The AI algorithms used are BFS, Better BFS (limit moves), A*, IDA*, and Mini (a minimizing version of MiniMax).
There are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance.
optional arguments:
-h, --help show this help message and exit
Expand All @@ -18,9 +20,9 @@ optional arguments:


# Example images:
![3D 2x2 GUI](/docs/images/3d_2x2.png)
![3D 2x2 GUI](/docs/3d_2x2.png)
3D 2X2 cube in GUI
![2D 2x2 GUI](/docs/images/2d_2x2.png)
![2D 2x2 GUI](/docs/2d_2x2.png)
2D 2x2 cube in GUI

# Documentation:
Expand Down
2 changes: 1 addition & 1 deletion main.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def ai(type, n, scramble_length, heuristic):
if __name__ == '__main__':
# Ask the user what they want to run and run it for them

parser = argparse.ArgumentParser(description='CubeAI\nCSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and possibly scaling up to higher order cubes. The AI algorithms used are BFS, Better BFS (limit moves), A*, IDA*, and Mini (a minimizing version of MiniMax). There are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance. ', formatter_class=argparse.RawTextHelpFormatter)
parser = argparse.ArgumentParser(description='CubeAI\nCSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and possibly scaling up to higher order cubes.\nThe AI algorithms used are BFS, Better BFS (limit moves), A*, IDA*, and Mini (a minimizing version of MiniMax)\nThere are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance.', formatter_class=argparse.RawTextHelpFormatter)
parser.add_argument('--m', metavar='False', default=False, type=bool, action='store', help='Run manually (start gui) or run the AI first')
parser.add_argument('--n', metavar='2', default=2, type=int, action='store', help='The dimension of the cube (nxn)')
parser.add_argument('--s', metavar='5', default=5, type=int, action='store', help='How many times to scramble the cube')
Expand Down

0 comments on commit 2823e84

Please sign in to comment.