aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranciszek Malinka <franciszek.malinka@gmail.com>2022-04-26 02:03:42 +0200
committerFranciszek Malinka <franciszek.malinka@gmail.com>2022-04-26 02:03:42 +0200
commit530c341960e528bb44dd6747f37c0c87c68537d8 (patch)
tree79d39985219e2a646a65fa3a8eec0934c8eac214
parent17910a26e021ab83d6e127fc01dff80deb12b650 (diff)
Readme update
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index db70ffb..d6a1a8d 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,10 @@ 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:
+## Building
+Simply run `make` in the root directory of the project. I compile it on Linux.
+
+## 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