aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFederico Igne <git@federicoigne.com>2022-08-13 11:46:05 +0100
committerFederico Igne <git@federicoigne.com>2022-08-13 11:46:05 +0100
commit280e45f13cdad1d19c833484a323da04bf3a1ce4 (patch)
treed29127caf6489b888764d502a46ea78bc2702566
parent2fd9cc46ff2428bb2fa891f47002e9d3e7585583 (diff)
downloadrubik-280e45f13cdad1d19c833484a323da04bf3a1ce4.tar.gz
rubik-280e45f13cdad1d19c833484a323da04bf3a1ce4.zip
docs: update README.md
-rwxr-xr-xREADME.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/README.md b/README.md
index de10feb..4c6f360 100755
--- a/README.md
+++ b/README.md
@@ -3,14 +3,32 @@
3 3
4<p align="center"> 4<p align="center">
5 A 2x2 Rubik's cube visualizer for Clingo, built with Three.js 5 A 2x2 Rubik's cube visualizer for Clingo, built with Three.js
6 <br>
7 <img src="https://git.dyamon.me/projects/rubik/plain/resources/screenshot.jpg" alt="PocketCube screenshot" width="400">
8</p> 6</p>
9 7
10# How to 8<p align="center"><img src="https://git.dyamon.me/projects/rubik/plain/resources/screenshot.jpg" alt="PocketCube screenshot"></p>
11 9
12Clone the repository and open `index.html` in your browser. 10# Running the simulator
13 11
14Click on `Select File` and load a previously exported file or a file containing the output of `asp/20_rubikigne.lp` (compatible with Clingo >=4.0.0). 121. Clone the repository
13
14 ```sh
15 git clone https://git.dyamon.me/projects/rubik
16 ```
17
18 or download a snapshot of the code with either
19
20 ```sh
21 https://git.dyamon.me/projects/rubik/snapshot/rubik-master.tar.gz
22 ```
23
24 or
25
26 ```sh
27 wget https://git.dyamon.me/projects/rubik/snapshot/rubik-master.zip
28 ```
29
301. Open `index.html` in your browser.
31
321. Click on `Select File` and load a previously exported file or a file containing the output of `asp/20_rubikigne.lp` (compatible with Clingo >=4.0.0).
15 33
16The `examples` folder contains a few examples. 34The `examples` folder contains a few examples.