From 0e8d73bb3edcc8bdff6e3ded442b66f68265059a Mon Sep 17 00:00:00 2001 From: Sebastiano Tronto Date: Sun, 21 Jun 2020 23:01:57 +0200 Subject: First push --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c57567e..581f36c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ # nissy -A Rubik's cube solver and FMC assistant +A Rubik's cube solver and FMC assistant. + +## Just another cube solver? +Yes, pretty much. I wanted to write one and I started coding without any +specific goal in mind. It is not more efficient than [CubeExplorer](http://kociemba.org/cube.htm), nor it is +particularly user-friendly. + +## But does it do something unique? +Yes, actually it does, but only for a very small niche of people. It allows to produce step-by-step solutions using DR +([Thistlethwaite](/https://www.speedsolving.com/wiki/index.php/Thistlethwaite%27s_algorithm)/[Kociemba](https://www.speedsolving.com/wiki/index.php/Kociemba%27s_Algorithm) algorithm) +combined 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, +or what was the optimal way to solve a certain substep at a given point, and so on. + +## How to use it +Check out the help pages in the docs folder. They are also available from +within nissy with the command "help". + +I will add more examples and maybe screenshots when I feel like. + +## Installation +For now you have to download all the files and compile the source +code yourself. Remember to tell your +compiler to use the [C99 standard](https://en.wikipedia.org/wiki/C99). For +example, on a Linux system with GCC installed: + +``` +cd path/to/nissy/src +gcc -O3 -std=c99 -o ../nissy *.c +cd .. +./nissy +``` + +You can also use the script compile.sh in the src folder, which executes that +gcc line (with a few extra options). + +## Tips +You can use a tool such as [rlwrap](https://github.com/hanslub42/rlwrap) to allow +for infinte command history within nissy! -- cgit v1.3