aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranciszek Malinka <franciszek.malinka@gmail.com>2022-04-26 01:47:14 +0200
committerFranciszek Malinka <franciszek.malinka@gmail.com>2022-04-26 01:47:14 +0200
commit51e2741ba5f5dc16fcea4c78c49ccc971c03d2a2 (patch)
tree2157511edce69a674fb5f411fee33d1614a48815
parentabadc0e24d7fd1ade52e3ced31892cf5037b9cf6 (diff)
Readme update
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9e00a5e..db70ffb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
# Solver4
-This is gonna be awesome!
+Algorithm for finding a solution for given Rubik's cube scramble.
+
+At the moment the solver is working, it is pretty fast actually (faster than
+I tought it would be and only tested on a few tests written by hand :P).
+
+TODOs:
+ - Move code from [cube.h](./src/cube.h) to a normal source file, not a header file...
+ - Clean up the code in general
+ - Document the code (mainly [cube.h](./src/cube.h)), in particular describe
+ how a cube state is represented and how a single rotation is performed
+ (I think its done pretty cool actually)
+ - Add a config file / command line options (for example it would be nice to
+ tweak heuristic parameters)
+ - Do some benchmarks! Explore some other heuristic functions, check for
+ bottlenecks etc.
+ - Maybe make a library?