aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastiano Tronto <sebastiano.tronto@gmail.com>2021-11-20 17:19:20 +0100
committerSebastiano Tronto <sebastiano.tronto@gmail.com>2021-11-20 17:19:20 +0100
commit3bc44cb7ee1f27d1e0183b82be6ba6b9c05e837c (patch)
treeaa8159b45464f78f968304b5bb23a9f3a1c1acb5
parent4b06b666a98ea0239b0c72a579f8434246fb2d39 (diff)
downloadnissy-3bc44cb7ee1f27d1e0183b82be6ba6b9c05e837c.tar.gz
nissy-3bc44cb7ee1f27d1e0183b82be6ba6b9c05e837c.zip
Added comments on multi-threading and windows installation instructions
-rw-r--r--README.md23
1 files changed, 16 insertions, 7 deletions
diff --git a/README.md b/README.md
index de56f9d..c6b3690 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
1# Nissy 1# Nissy
2 2
3A Rubik's cube solver and FMC assistant. For optimal HTM solving nissy is about as 3A Rubik's cube solver and FMC assistant.
4fast as Herbert Kociemba's [Cube Explorer](http://kociemba.org/cube.htm), and it 4For optimal HTM solving nissy uses the same method as Herbert Kociemba's
5uses 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
6its performance are comparable, but nissy is much faster when using multiple
7threads (with the -t option for the solve command).
8issy can also solve many different substeps of
6Thistlethwaite's algorithm (DR/HTR), and can use NISS (Normal-Inverse Scramble Switch). 9Thistlethwaite's algorithm (DR/HTR), and can use NISS (Normal-Inverse Scramble Switch).
7 10
8It can be useful to analyze your DR solves (and more, once I implement more features). 11It 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
33Try downloading and executing in a terminal the file nissy.exe, then
34follow the instructions in the UNIX section below for downloading and
35installing the pruning tables.
36If nissy.exe does not work, you can try following the UNIX instructions
37in WSL (Windows Subsystem for Linux) or in a similar environment.
38
39Sorry 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
30You can download the source code for the latest version from git or simply clone 43You 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
49the whole folder, not the single files). The `nohuge` files are much smaller and 62the whole folder, not the single files). The `nohuge` files are much smaller and
50do not contain the huge pruning table for the optimal solver. 63do not contain the huge pruning table for the optimal solver.
51 64
52### On Windows
53
54Coming soon.
55
56## Structure of the code 65## Structure of the code
57 66
58You can find all the source code in the `src` folder. 67You can find all the source code in the `src` folder.

Generated with cgit - Back to sebastiano.tronto.net