diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 35 |
1 files changed, 31 insertions, 4 deletions
| @@ -99,10 +99,20 @@ file in the tools/results folder. | |||
| 99 | 99 | ||
| 100 | To build and run a tool in debug mode, use `make debugtool`. | 100 | To build and run a tool in debug mode, use `make debugtool`. |
| 101 | 101 | ||
| 102 | ## Running commands manually | 102 | ## User interfaces |
| 103 | 103 | ||
| 104 | This project also includes a rudimentary shell that can be used to run | 104 | User interfaces for this software are in an experimental stage. Some |
| 105 | commands manually. To build the shell use: | 105 | examples are included in this repository, but they are not polished. |
| 106 | If you are a developer and you are interested in contributing, have a | ||
| 107 | look at the examples and let me know! | ||
| 108 | |||
| 109 | ## Command-line interface | ||
| 110 | |||
| 111 | The `shell` folder contains the code for a rudimentary shell that can | ||
| 112 | be used to run commands manually. The user experience in not amazing, | ||
| 113 | as the commands require quite verbose options. | ||
| 114 | |||
| 115 | To build the shell run: | ||
| 106 | 116 | ||
| 107 | ``` | 117 | ``` |
| 108 | $ make shell | 118 | $ make shell |
| @@ -150,7 +160,24 @@ $ ./run solve_scramble -solver h48h0k4 -n 1 -M 4 -moves "R' U' F" | |||
| 150 | F' U' R | 160 | F' U' R |
| 151 | ``` | 161 | ``` |
| 152 | 162 | ||
| 153 | For a full list of available command, use `run help`. | 163 | For a full list of available command, use `./run help`. |
| 164 | |||
| 165 | ### QT | ||
| 166 | |||
| 167 | A draft for a QT-based GUI is contained in the `qt` folder. In order | ||
| 168 | to build it you need QT libraries and headers (for QML / QT Quick | ||
| 169 | development) and CMake. If your environment is set up, you can | ||
| 170 | build the QT GUI with | ||
| 171 | |||
| 172 | ``` | ||
| 173 | $ make qt | ||
| 174 | ``` | ||
| 175 | |||
| 176 | And then run it with | ||
| 177 | |||
| 178 | ``` | ||
| 179 | $ ./nissyqt | ||
| 180 | ``` | ||
| 154 | 181 | ||
| 155 | ## Using this software as a library | 182 | ## Using this software as a library |
| 156 | 183 | ||
