README update

n-peugnet · Nov 11, 2018 · b1593be · b1593be
1 parent 78bbba9
commit b1593be
Showing 1 changed file with 62 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -20,65 +20,88 @@ _The checked ones are implemented, the others are the ones I plan to add in the
 -   [x] zoom in & out
 -   [X] pan (dragging with MouseWheel click)
 -   [x] show a menu by right-clicking on an area with these options :
-	-   [x] set url
-	-   [x] delete
-	-   [x] move forward
-	-   [x] move backwards
+    -   [x] set url
+    -   [x] delete
+    -   [x] move forward
+    -   [x] move backwards
 -   [x] differents tools :
-	-   [x] rectangle mode
-	-   [x] circle mode
-	-   [x] polygon mode
-	-   [X] move mode
-	-   [x] inspect mode
-	-   [ ] select mode
-	-   [ ] resize mode ?
-	-   [x] delete mode
-	-   [ ] test mode
+    -   [x] rectangle mode
+    -   [x] circle mode
+    -   [x] polygon mode
+    -   [X] move mode
+    -   [x] inspect mode
+    -   [ ] select mode
+    -   [ ] resize mode ?
+    -   [x] delete mode
+    -   [ ] test mode
 -   [ ] differents drawing modes for rectangles :
-	-   [x] dram from edges
-	-   [ ] draw from center (with `alt`)
-	-   [ ] draw square (with `shift`)
+    -   [x] dram from edges
+    -   [ ] draw from center (with `alt`)
+    -   [ ] draw square (with `shift`)
 -   [ ] differents drawing modes for circles :
-	-   [ ] draw from edges
-	-   [x] draw from center (later with `shift`)
+    -   [ ] draw from edges
+    -   [x] draw from center (later with `shift`)
 -   [x] gui with these features :
-	-   [x] select tool mode
-	-   [x] undo
-	-   [x] redo
-	-   [x] export the result as a valid html map
-	-   [ ] export the result as a usable svg map
-	-   [x] export the result as JSON
-	-   [x] import from JSON
-
-## How to Integrate it
-
-You need to import `p5.js`, `p5.dom.js`, the js bundle from `/dist` and
-the contextmenu library in your html page. Then instantiate the p5 object
+    -   [x] select tool mode
+    -   [x] undo
+    -   [x] redo
+    -   [x] export the result as a valid html map
+    -   [ ] export the result as a usable svg map
+    -   [x] export the result as JSON
+    -   [x] import from JSON
+
+## Integration
+
+You just need to import `p5.js`, `p5.dom.js` and the bundle from `/dist`. Then instantiate the p5 object
 like this :
 
-```JavaScript
+```js
 let iMap = new imageMapCreator();
 let sketch = new p5(iMap.sketch.bind(iMap), "div-1");
 ```
 
 The contructor of imageMapCreator accepts parameters:
 
-```Javascript
+```js
 new imageMapCreator([ width = 600 [, height = 450 ]]);
 ```
 
 For more details on the instance mode of p5 see [the p5 documentation](https://p5js.org/examples/instance-mode-instance-container.html)
 
-You can also see the detailled example in the `/demos` folder.
+You can also see the detailled example in the [`/demos`](demos) folder.
+
+## Development
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+
+1.  Git
+2.  Nodejs & NPM
+
+### Installing
+
+1.  clone with `--recurse-submodules` option or download this repository and install git submodules:
+    ```shell
+    git submodule init
+    git submodule update
+    ```
+2.  install dependencies:
+    ```shell
+    npm install
+    ```
+3.  launch webpack:
+    ```shell
+    npm run watch
+    ```
 
 ## Built with
 
--   [p5.js](https://github.com/processing/p5.js) - an easy canvas drawing library - [website](http://p5js.org/)
--   [quicksettings](https://github.com/bit101/quicksettings) - a quick and easy settings creation library - [website](http://bit101.github.io/quicksettings/)
--   [Undo Manager](https://github.com/ArthurClemens/Javascript-Undo-Manager) - a light undo manager library
--   [contextmenu](https://github.com/theyak/contextmenu) - a light right-click menu creation library
--   [download.js](http://danml.com/download.html) - a one liner function to download files client side
--   [Rawgit](https://rawgit.com/) - a content delivery network based on github's raw files
+-   [p5.js](https://github.com/processing/p5.js) - easy canvas drawing library - [website](http://p5js.org/)
+-   [quicksettings](https://github.com/bit101/quicksettings) - quick and easy settings creation library - [website](http://bit101.github.io/quicksettings/)
+-   [Undo Manager](https://github.com/ArthurClemens/Javascript-Undo-Manager) - light undo manager library
+-   [contextmenu](https://github.com/theyak/contextmenu) - light right-click menu creation library
+-   [download.js](https://github.com/rndme/download) - one liner function to download files client side - [website](http://danml.com/download.html)
 
 ## Authors