From 530c341960e528bb44dd6747f37c0c87c68537d8 Mon Sep 17 00:00:00 2001 From: Franciszek Malinka Date: Tue, 26 Apr 2022 02:03:42 +0200 Subject: Readme update --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'README.md') 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 -- cgit v1.2.3