Skip to content

Commit 2823e84

Browse files
committed
fixing readme and adding new line
1 parent c95c0a3 commit 2823e84

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ CSCI-B 351 final project with the goal of making an AI to solve a 2x2 cube and p
55
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:
66
```
77
CubeAI
8-
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.
8+
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.
9+
The AI algorithms used are BFS, Better BFS (limit moves), A*, IDA*, and Mini (a minimizing version of MiniMax).
10+
There are 3 heuristics implimented: simpleHeuristic, hammingDistance and manhattanDistance.
911
1012
optional arguments:
1113
-h, --help show this help message and exit
@@ -18,9 +20,9 @@ optional arguments:
1820

1921

2022
# Example images:
21-
![3D 2x2 GUI](/docs/images/3d_2x2.png)
23+
![3D 2x2 GUI](/docs/3d_2x2.png)
2224
3D 2X2 cube in GUI
23-
![2D 2x2 GUI](/docs/images/2d_2x2.png)
25+
![2D 2x2 GUI](/docs/2d_2x2.png)
2426
2D 2x2 cube in GUI
2527

2628
# Documentation:

main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def ai(type, n, scramble_length, heuristic):
7979
if __name__ == '__main__':
8080
# Ask the user what they want to run and run it for them
8181

82-
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)
82+
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)
8383
parser.add_argument('--m', metavar='False', default=False, type=bool, action='store', help='Run manually (start gui) or run the AI first')
8484
parser.add_argument('--n', metavar='2', default=2, type=int, action='store', help='The dimension of the cube (nxn)')
8585
parser.add_argument('--s', metavar='5', default=5, type=int, action='store', help='How many times to scramble the cube')

0 commit comments

Comments
 (0)