aboutsummaryrefslogtreecommitdiff
path: root/www/index.html
diff options
context:
space:
mode:
authorSebastiano Tronto <sebastiano@tronto.net>2023-05-03 10:43:26 +0200
committerSebastiano Tronto <sebastiano@tronto.net>2023-05-03 10:43:26 +0200
commit8c07d707f794f3935d395e5f6276053164e2ea73 (patch)
treeded4555a37d783c2567a5d4327a7e624960f6977 /www/index.html
parentd3852e44b7d16955aec581d73e641fe495cb1420 (diff)
downloadnissy-classic-8c07d707f794f3935d395e5f6276053164e2ea73.tar.gz
nissy-classic-8c07d707f794f3935d395e5f6276053164e2ea73.zip
Bumped version to 2.0.4; added back www
Diffstat (limited to 'www/index.html')
-rw-r--r--www/index.html253
1 files changed, 253 insertions, 0 deletions
diff --git a/www/index.html b/www/index.html
new file mode 100644
index 0000000..ee1469e
--- /dev/null
+++ b/www/index.html
@@ -0,0 +1,253 @@
1<!doctype html>
2<html lang="en">
3<head>
4 <title> Nissy </title>
5 <meta name="viewport" content="width=device-width" />
6 <link rel="stylesheet" type="text/css" href="/style-3.css">
7 <link rel="icon" href="/favicon.png">
8 <meta charset="utf-8">
9</head>
10
11<body>
12
13<h1>Nissy</h1>
14
15<p class=subtitle>A Rubik's cube solver and FMC assistant</p>
16
17<p>
18Nissy is a command-line Rubik's cube solver. It can find optimal solutions
19for random positions using techniques from Herbert Kociemba's
20<a href="http://kociemba.org/cube.htm">Cube Explorer</a> and
21Tomas Rokicki's
22<a href="https://github.com/rokici/cube20src/blob/master/nxopt.md">nxopt</a>.
23With 4 cores at 2.5GHz and using about 3Gb of RAM, Nissy can find an optimal
24solution in about a minute on average.
25</p>
26
27<p>
28Nissy aims at being a complete tool
29for FMC (Fewest Moves Challenge) practice. It can solve different steps
30of Thistlethwaite's algorithm (also know as DR/HTR) and cans use NISS
31(Normal-Inverse Scramble Switch).
32</p>
33
34<p>
35You should use Nissy if:
36</p>
37<ul>
38<li>
39You want to analyze your DR solutions or check for multiple optimal
40(or sub-optimal) solutions for EO/DR/HTR or similar steps.
41</li>
42<li>
43You just want a Rubik's cube solver and you like command line interfaces.
44</li>
45<li>
46You want an alternative to Cube Explorer.
47</li>
48</ul>
49
50<p>
51To get started, head to the <a href="/download/">download</a> page.
52</p>
53
54<p>
55You can also look at its source code by cloning the git repository
56<a href="https://git.tronto.net/nissy-classic">git.tronto.net/nissy-classic</a>
57</p>
58
59<h1>Get Nissy</h1>
60
61<table class="dltable">
62<tr>
63 <td></td>
64 <td><strong>Source code</strong></td>
65 <td><strong>Windows executable</strong></td>
66</tr>
67<tr>
68 <td><strong>Latest version</strong></td>
69 <td><a href="/nissy-2.0.4.tar.gz">nissy-2.0.4.tar.gz (67Kb)</a></td>
70 <td><a href="/nissy-2.0.4.exe">nissy-2.0.4.exe (780Kb)</a></td>
71</tr>
72</table>
73
74<p>
75In this page you can find download links (see above),
76<a href="#Installation">installation instructions</a> and
77<a href="#Upgrade">upgrade instructions</a>
78for nissy. If instead you wish to clone the
79<a href="https://git.tronto.net/nissy-classic">git repository</a>,
80you can use git:
81</p>
82
83<pre>
84<code>git clone https://git.tronto.net/nissy-classic</code>
85</pre>
86
87<p>
88For a summary of changes and a list of older versions see below. Some versions
89(for example 1.0) are not available directly, but can be obtained from
90the git repository.
91</p>
92
93<h2 id="Installation">Installation</h2>
94
95<h3>System requirements</h3>
96
97<p>
98A full installation of nissy requires about 3.1Gb of space,
99of which 2.3Gb are occupied by the huge pruning table for fast optimal solving,
100and running it requires the same amount of RAM.
101One can choose to never use this function and not to install the relative
102pruning table. There is an alternative (slower)
103optimal solving function that uses about 500Mb of RAM.
104
105When generating the pruning tables automatically (see the section Tables below),
106at least 5.3Gb or RAM are required.
107</p>
108
109<h3>Windows</h3>
110
111<p>
112Try downloading and executing in a terminal the file <code>nissy.exe</code>,
113then follow the instructions in the <strong>Tables</strong> section below for
114installing the pruning tables.
115If <code>nissy.exe</code> does not work, you can try following the UNIX instructions
116in WSL (Windows Subsystem for Linux) or in a similar environment.
117</p>
118
119<h3>UNIX (Linux, MacOS, *BSD...)</h3>
120<p>
121Download the source archive (.tar.gz). Extract it
122with your favorite archive program, for example with
123</p>
124<pre><code>tar -xvzf nissy-VERSION.tar.gz</code></pre>
125<p>
126Open a terminal in the directory just extracted.
127If you wish, edit the <code>Makefile</code> to match your local configuration
128(this is usually not necessary, but you may want to change the
129<code>PREFIX</code> variable to change the installation path) and run
130<pre><code>make</code></pre>
131<p>
132followed by
133</p>
134<pre><code>make install</code></pre>
135<p>
136Then follow the instructions below to install the pruning tables.
137</p>
138
139<h3>Tables</h3>
140
141<p>
142Once you have installed nissy, run
143</p>
144
145<pre><code>nissy gen</code></pre>
146
147<p>
148to generate all the tables that Nissy will ever need.
149Running this command requires around 5.3Gb of RAM, and it can take some time
150(about 40 minutes on my fairly old but decent laptop, with 8 CPU threads).
151</p>
152
153<p>
154Some unnecessary technical detail: by default this command is going to use
155at most 64 threads. If you want you can choose to use more threads (if your CPU
156is very powerful) or fewer threads (if you for example want to run this command
157in the background while you do other stuff) with the <code>-t</code> option, for
158example <code>nissy gen -t 1</code>.
159</p>
160
161<p>
162Alternatively, you can
163<a href="/nissy-tables-2.0.4.zip">download all the tables (1.7Gb)</a> and
164copy them into the correct folder (see manual page, <code>ENVIRONMENT</code>
165section). On UNIX operating systems this folder is either
166<code>.nissy/tables</code> in the user's home directory or
167<code>$XDG_DATA_HOME/nissy/tables</code> if the XDG variable is configured.
168On Windows it is the same directory as the <code>nissy.exe</code> executable
169file.
170</p>
171
172<h2 id="Upgrade">Upgrading</h2>
173<p>
174If you already have nissy installed and you want to upgrade to a more
175recent version, you can simply repeat the installation process:
176</p>
177<ul>
178<li>
179On Windows: simply replace nissy.exe with the new file with the same name.
180</li>
181<li>
182On UNIX systems: download the new version of the source code, extract it in
183a new folder and run <code>make</code> and <code>make install</code> again.
184</li>
185</ul>
186<p>
187Between each version new table files might have been added, or old ones
188may be not used anymore. Nissy will deal with this automatically.
189</p>
190
191<h2>Version history</h2>
192
193<h3>Nissy v2</h3>
194
195<table class=dltable>
196<tr>
197 <td><strong>Version</strong></td>
198 <td><strong>Date</strong></td>
199 <td><strong>Comment</strong></td>
200</tr>
201<tr>
202 <td><a href="/nissy-2.0.4.tar.gz">2.0.4</a></td>
203 <td>2023-05-03</td>
204 <td>Fixed bug on ARM; added corners-dr step</td>
205</tr>
206<tr>
207 <td><a href="/nissy-2.0.3.tar.gz">2.0.3</a></td>
208 <td>2022-09-10</td>
209 <td>Fixed bug in scramble dr</td>
210</tr>
211<tr>
212 <td><a href="/nissy-2.0.2.tar.gz">2.0.2</a></td>
213 <td>2022-06-01</td>
214 <td>Improved table generation speed</td>
215</tr>
216<tr>
217 <td><a href="/nissy-2.0.1.tar.gz">2.0.1</a></td>
218 <td>2022-02-22</td>
219 <td>Bugfix release</td>
220</tr>
221<tr>
222 <td>2.0</td>
223 <td>2021-12-29</td>
224 <td>Rewritten from scratch; much faster optimal solver</td>
225</tr>
226</table>
227
228<h3>Nissy v1</h3>
229
230<p>
231Nissy v1 was released in 2020. It was slow, full of bugs and the code
232was quite terrible. But in practice it got its job done most of the time.
233</p>
234
235<hr class="line">
236
237<nav class="bottom">
238 <table class="footer">
239 <tr>
240 <td class="contact">
241 <a href="https://sebastiano.tronto.net">sebastiano.tronto.net</a>
242 </td>
243 <td class="hosted">
244 <a href="mailto:sebastiano@tronto.net">
245 sebastiano@tronto.net
246 </a>
247 </td>
248 </tr>
249 </table>
250</nav>
251
252</body>
253</html>

Generated with cgit - Back to sebastiano.tronto.net