diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 72 |
1 files changed, 3 insertions, 69 deletions
| @@ -11,75 +11,9 @@ Nissy can also solve many different substeps of Thistlethwaite's algorithm | |||
| 11 | (DR/HTR), and can use NISS (Normal-Inverse Scramble Switch). | 11 | (DR/HTR), and can use NISS (Normal-Inverse Scramble Switch). |
| 12 | It can be useful to analyze your DR solves (and more, once I implement more features). | 12 | It can be useful to analyze your DR solves (and more, once I implement more features). |
| 13 | 13 | ||
| 14 | ## Why should I use Nissy? | 14 | You get Nissy from [nissy.tronto.net](https://nissy.tronto.net). The download |
| 15 | 15 | links and installation instructions can be found on the | |
| 16 | You should use Nissy if you: | 16 | [download page](https://nissy.tronto.net/download). |
| 17 | |||
| 18 | * Want to analyze your DR solutions or check for multiple optimal (or sub-optimal) | ||
| 19 | solutions for EO/DR/HTR or similar substeps. | ||
| 20 | * You just want a Rubik's cube solver and you like command line interfaces. | ||
| 21 | * You want an alternative to Cube Explorer. | ||
| 22 | |||
| 23 | ## Requirements | ||
| 24 | |||
| 25 | A full installation of nissy requires about 3Gb of space, | ||
| 26 | of which 2.3Gb are occupied by the huge pruning table for fast optimal solving, | ||
| 27 | and running it requires the same amount of RAM. | ||
| 28 | One can choose to never use this function and not to install the relative | ||
| 29 | pruning table. There is an alternative (slower) | ||
| 30 | optimal solving function that uses about 500Mb of RAM. | ||
| 31 | |||
| 32 | ## Installation | ||
| 33 | |||
| 34 | ### On Windows | ||
| 35 | |||
| 36 | Try downloading and executing in a terminal the file nissy.exe, then | ||
| 37 | follow the instructions in the **Tables** section below for | ||
| 38 | installing the pruning tables. | ||
| 39 | If nissy.exe does not work, you can try following the UNIX instructions | ||
| 40 | in WSL (Windows Subsystem for Linux) or in a similar environment. | ||
| 41 | |||
| 42 | Sorry for the inconvenience, I don't have a Windows machine to test this on. | ||
| 43 | |||
| 44 | ### On a UNIX system: | ||
| 45 | |||
| 46 | Edit the Makefile to match your local configuration (usually not necessary, but you | ||
| 47 | may want to change the `PREFIX` variable) and run `make`, followed by `make install`. | ||
| 48 | Follows the instructions below to install the pruning tables. | ||
| 49 | |||
| 50 | ### Tables | ||
| 51 | Nissy needs to generate certain large tables to work. These tables are by default | ||
| 52 | generated the first time they are needed (e.g the first time you ask to solve a | ||
| 53 | certain step) and then saved to a file. Whenever these tables are needed again, | ||
| 54 | nissy simply loads the corresponding file from the hard disk. | ||
| 55 | |||
| 56 | The very large table for optimal solving can take some time to generate | ||
| 57 | (about 1.5 hours on my fairly old but decent laptop, using 8 CPU threads). | ||
| 58 | In order to generate it you need at least 5Gb or RAM. | ||
| 59 | All other tables are much faster. | ||
| 60 | |||
| 61 | You can ask Nissy to generate all the tables it will ever need with the `gen` | ||
| 62 | command. It is recommended to use more than one thread, if your CPU has them. | ||
| 63 | For example, you can run: | ||
| 64 | |||
| 65 | ``` | ||
| 66 | nissy gen -t 8 | ||
| 67 | ``` | ||
| 68 | |||
| 69 | to generate all tables using 8 threads. | ||
| 70 | |||
| 71 | Alternatively, you can simply download all the tables and copy them into the | ||
| 72 | correct folder (see manual page, `ENVIRONMENT` section). On UNIX operating | ||
| 73 | systems this folder is either `.nissy/tables` in the user's home directory or | ||
| 74 | `$XDG_DATA_HOME/nissy/tables` if the XDG variable is configured. On Windows | ||
| 75 | it is the same directory as the nissy.exe executable file. | ||
| 76 | |||
| 77 | Choose either the | ||
| 78 | [zip](https://nissy.tronto.net/nissy-tables-2.0.zip) | ||
| 79 | or the | ||
| 80 | [tar.gz](https://nissy.tronto.net/nissy-tables-2.0.tar.gz) | ||
| 81 | file (click the links to download) and | ||
| 82 | extract them in the correct folder. | ||
| 83 | 17 | ||
| 84 | ## Structure of the code | 18 | ## Structure of the code |
| 85 | 19 | ||
