Move example -> documentation

purescript-contrib · Aug 2, 2017 · 4ce675a · 4ce675a
1 parent 470e9ff
commit 4ce675a
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,9 +9,9 @@
 /output/
 /.psci*
 
-/example/bower_components/
-/example/.pulp-cache/
-/example/output/
-/example/.psci*
+/documentation/bower_components/
+/documentation/.pulp-cache/
+/documentation/output/
+/documentation/.psci*
 
-/example/html/test.js
+/documentation/html/test.js
diff --git a/README.md b/README.md
@@ -32,15 +32,15 @@ Based on initial work by paf31 and inspired by (the PureScript version of) [Elm.
 
 ## Development
 
-For running the (interactive) tests, the following steps are necessary:
+To run the unit tests, the following steps are necessary:
+```
+bower install
+pulp test
 ```
-npm i
-bower i
-cd example && bower i && cd ..
-
-# Run unit tests:
-npm t
 
-# Build interactive tests / documentation:
-npm run example
+To build the interactive docmentation, run:
+```
+cd documentation
+bower install
+pulp build -O -m Main -t html/test.js
 ```
diff --git a/example/bower.json → documentation/bower.json b/example/bower.json → documentation/bower.json
diff --git a/example/html/flarecheck.css → documentation/html/flarecheck.css b/example/html/flarecheck.css → documentation/html/flarecheck.css
diff --git a/example/html/index.html → documentation/html/index.html b/example/html/index.html → documentation/html/index.html
diff --git a/example/html/purescript-colors.json → documentation/html/purescript-colors.json b/example/html/purescript-colors.json → documentation/html/purescript-colors.json
diff --git a/example/src/Main.purs → documentation/src/Main.purs b/example/src/Main.purs → documentation/src/Main.purs
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
   "private": true,
   "scripts": {
-    "build": "pulp test && rimraf docs && pulp docs",
-    "example": "cd example && pulp build -O -m Main -t html/test.js",
+    "build": "bower install && pulp build",
+    "documentation": "cd example && pulp build -O -m Main -t html/test.js",
     "test": "pulp test"
   },
   "devDependencies": {