aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/README.md b/README.md
index c57567e..581f36c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
1# nissy 1# nissy
2A Rubik's cube solver and FMC assistant 2A Rubik's cube solver and FMC assistant.
3
4## Just another cube solver?
5Yes, pretty much. I wanted to write one and I started coding without any
6specific goal in mind. It is not more efficient than [CubeExplorer](http://kociemba.org/cube.htm), nor it is
7particularly user-friendly.
8
9## But does it do something unique?
10Yes, actually it does, but only for a very small niche of people. It allows to produce step-by-step solutions using DR
11([Thistlethwaite](/https://www.speedsolving.com/wiki/index.php/Thistlethwaite%27s_algorithm)/[Kociemba](https://www.speedsolving.com/wiki/index.php/Kociemba%27s_Algorithm) algorithm)
12combined with [NISS](https://www.speedsolving.com/wiki/index.php/Fewest_Moves_techniques). This makes it somewhat useful for [FMC](https://www.speedsolving.com/wiki/index.php/Fewest_Moves_Challenge) solvers who want to analyze a scramble and see if they missed something,
13or what was the optimal way to solve a certain substep at a given point, and so on.
14
15## How to use it
16Check out the help pages in the docs folder. They are also available from
17within nissy with the command "help".
18
19I will add more examples and maybe screenshots when I feel like.
20
21## Installation
22For now you have to download all the files and compile the source
23code yourself. Remember to tell your
24compiler to use the [C99 standard](https://en.wikipedia.org/wiki/C99). For
25example, on a Linux system with GCC installed:
26
27```
28cd path/to/nissy/src
29gcc -O3 -std=c99 -o ../nissy *.c
30cd ..
31./nissy
32```
33
34You can also use the script compile.sh in the src folder, which executes that
35gcc line (with a few extra options).
36
37## Tips
38You can use a tool such as [rlwrap](https://github.com/hanslub42/rlwrap) to allow
39for infinte command history within nissy!

Generated with cgit - Back to sebastiano.tronto.net