Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
muodov committed Dec 23, 2015
1 parent 15c40f5 commit 92e0a5a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@ Original Java implementation can be found here: http://kociemba.org/download.htm
These ports are pretty straightforward (not to say dumb) and most probably can be optimized. But they have been extensively tested in our [Rubik's cube solving machine](https://blog.zok.pw/hacking/2015/08/18/fac-rubik-solver/), so be confident the algorithm is working.

## C version
C sources reside in the ```ckociemba``` folder. Running ```make``` in a root folder will compile a binary called ```solve```. It accepts a cube representation as a commandline argument, and writes the solution to the standard output. You can, of course, use it as a library.
C sources reside in the ```ckociemba``` folder. Running ```make``` in a root folder will compile a binary called ```solve```. It accepts a cube representation as a commandline argument, and writes the solution to the standard output. You can, of course, use ```ckociemba``` sources directly in your projects.

## Python version
Python version is located in ```kociemba``` directory. It is quite slow. It is probably better just to use Python's subprocess module and run a compiled C version. However, if you want pure Python, I would recommend running it with PyPy. On my Raspberry Pi version B it takes up to one minute to find a solution for a single cube.

## Future plans
I'm going to publish a proper Python wrapper around C version so that it can be imported into Python programs. Stay tuned :)

## Testing
In the root directory you can find a test script that contains some tests, generated by the original Java implementation. Run it like this:

Expand Down

0 comments on commit 92e0a5a

Please sign in to comment.