diff options
| -rw-r--r-- | README.md | 23 |
1 files changed, 16 insertions, 7 deletions
| @@ -1,8 +1,11 @@ | |||
| 1 | # Nissy | 1 | # Nissy |
| 2 | 2 | ||
| 3 | A Rubik's cube solver and FMC assistant. For optimal HTM solving nissy is about as | 3 | A Rubik's cube solver and FMC assistant. |
| 4 | fast as Herbert Kociemba's [Cube Explorer](http://kociemba.org/cube.htm), and it | 4 | For optimal HTM solving nissy uses the same method as Herbert Kociemba's |
| 5 | uses the same method. Nissy can also solve many different substeps of | 5 | [Cube Explorer](http://kociemba.org/cube.htm). When using a single CPU thread |
| 6 | its performance are comparable, but nissy is much faster when using multiple | ||
| 7 | threads (with the -t option for the solve command). | ||
| 8 | issy can also solve many different substeps of | ||
| 6 | Thistlethwaite's algorithm (DR/HTR), and can use NISS (Normal-Inverse Scramble Switch). | 9 | Thistlethwaite's algorithm (DR/HTR), and can use NISS (Normal-Inverse Scramble Switch). |
| 7 | 10 | ||
| 8 | It can be useful to analyze your DR solves (and more, once I implement more features). | 11 | It can be useful to analyze your DR solves (and more, once I implement more features). |
| @@ -25,6 +28,16 @@ pruning table. If so, about 200Mb should be enough. | |||
| 25 | 28 | ||
| 26 | ## Installation | 29 | ## Installation |
| 27 | 30 | ||
| 31 | ### On Windows | ||
| 32 | |||
| 33 | Try downloading and executing in a terminal the file nissy.exe, then | ||
| 34 | follow the instructions in the UNIX section below for downloading and | ||
| 35 | installing the pruning tables. | ||
| 36 | If nissy.exe does not work, you can try following the UNIX instructions | ||
| 37 | in WSL (Windows Subsystem for Linux) or in a similar environment. | ||
| 38 | |||
| 39 | Sorry for the inconvenience, I don't have a Windows machine to test this on. | ||
| 40 | |||
| 28 | ### On a UNIX system: | 41 | ### On a UNIX system: |
| 29 | 42 | ||
| 30 | You can download the source code for the latest version from git or simply clone | 43 | You can download the source code for the latest version from git or simply clone |
| @@ -49,10 +62,6 @@ extract the archive and copy the `tables` folder into `NISSIDATA` (paste there | |||
| 49 | the whole folder, not the single files). The `nohuge` files are much smaller and | 62 | the whole folder, not the single files). The `nohuge` files are much smaller and |
| 50 | do not contain the huge pruning table for the optimal solver. | 63 | do not contain the huge pruning table for the optimal solver. |
| 51 | 64 | ||
| 52 | ### On Windows | ||
| 53 | |||
| 54 | Coming soon. | ||
| 55 | |||
| 56 | ## Structure of the code | 65 | ## Structure of the code |
| 57 | 66 | ||
| 58 | You can find all the source code in the `src` folder. | 67 | You can find all the source code in the `src` folder. |
