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

Generated with cgit - Back to sebastiano.tronto.net