From 280e45f13cdad1d19c833484a323da04bf3a1ce4 Mon Sep 17 00:00:00 2001 From: Federico Igne Date: Sat, 13 Aug 2022 11:46:05 +0100 Subject: docs: update README.md --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index de10feb..4c6f360 100755 --- a/README.md +++ b/README.md @@ -3,14 +3,32 @@

A 2x2 Rubik's cube visualizer for Clingo, built with Three.js -
- PocketCube screenshot

-# How to +

PocketCube screenshot

-Clone the repository and open `index.html` in your browser. +# Running the simulator -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). +1. Clone the repository + + ```sh + git clone https://git.dyamon.me/projects/rubik + ``` + + or download a snapshot of the code with either + + ```sh + https://git.dyamon.me/projects/rubik/snapshot/rubik-master.tar.gz + ``` + + or + + ```sh + wget https://git.dyamon.me/projects/rubik/snapshot/rubik-master.zip + ``` + +1. Open `index.html` in your browser. + +1. 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). The `examples` folder contains a few examples. -- cgit v1.2.3