From f2db614faffca90b514828cc045dde9be48c6802 Mon Sep 17 00:00:00 2001 From: Sebastiano Tronto Date: Tue, 22 Feb 2022 00:17:33 +0100 Subject: Added website; released 2.0.1 --- README.md | 72 +++------------------------------------------------------------ 1 file changed, 3 insertions(+), 69 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6e249ba..64e29ea 100644 --- a/README.md +++ b/README.md @@ -11,75 +11,9 @@ Nissy can also solve many different substeps of Thistlethwaite's algorithm (DR/HTR), and can use NISS (Normal-Inverse Scramble Switch). It can be useful to analyze your DR solves (and more, once I implement more features). -## Why should I use Nissy? - -You should use Nissy if you: - -* Want to analyze your DR solutions or check for multiple optimal (or sub-optimal) -solutions for EO/DR/HTR or similar substeps. -* You just want a Rubik's cube solver and you like command line interfaces. -* You want an alternative to Cube Explorer. - -## Requirements - -A full installation of nissy requires about 3Gb of space, -of which 2.3Gb are occupied by the huge pruning table for fast optimal solving, -and running it requires the same amount of RAM. -One can choose to never use this function and not to install the relative -pruning table. There is an alternative (slower) -optimal solving function that uses about 500Mb of RAM. - -## Installation - -### On Windows - -Try downloading and executing in a terminal the file nissy.exe, then -follow the instructions in the **Tables** section below for -installing the pruning tables. -If nissy.exe does not work, you can try following the UNIX instructions -in WSL (Windows Subsystem for Linux) or in a similar environment. - -Sorry for the inconvenience, I don't have a Windows machine to test this on. - -### On a UNIX system: - -Edit the Makefile to match your local configuration (usually not necessary, but you -may want to change the `PREFIX` variable) and run `make`, followed by `make install`. -Follows the instructions below to install the pruning tables. - -### Tables -Nissy needs to generate certain large tables to work. These tables are by default -generated the first time they are needed (e.g the first time you ask to solve a -certain step) and then saved to a file. Whenever these tables are needed again, -nissy simply loads the corresponding file from the hard disk. - -The very large table for optimal solving can take some time to generate -(about 1.5 hours on my fairly old but decent laptop, using 8 CPU threads). -In order to generate it you need at least 5Gb or RAM. -All other tables are much faster. - -You can ask Nissy to generate all the tables it will ever need with the `gen` -command. It is recommended to use more than one thread, if your CPU has them. -For example, you can run: - -``` -nissy gen -t 8 -``` - -to generate all tables using 8 threads. - -Alternatively, you can simply download all the tables and copy them into the -correct folder (see manual page, `ENVIRONMENT` section). On UNIX operating -systems this folder is either `.nissy/tables` in the user's home directory or -`$XDG_DATA_HOME/nissy/tables` if the XDG variable is configured. On Windows -it is the same directory as the nissy.exe executable file. - -Choose either the -[zip](https://nissy.tronto.net/nissy-tables-2.0.zip) -or the -[tar.gz](https://nissy.tronto.net/nissy-tables-2.0.tar.gz) -file (click the links to download) and -extract them in the correct folder. +You get Nissy from [nissy.tronto.net](https://nissy.tronto.net). The download +links and installation instructions can be found on the +[download page](https://nissy.tronto.net/download). ## Structure of the code -- cgit v1.3