Permalink
Browse files

update readme

  • Loading branch information...
1 parent fa77eaa commit 229c50aec176aa1b98e22b2f56d14d1f0fe4989b @drichard committed Jun 24, 2012
Showing with 5 additions and 15 deletions.
  1. +5 −15 README.md
View
@@ -5,8 +5,8 @@ mindmaps is a prototype of an HTML5 based mind mapping application. It lets you
- Written entirely in JavaScript
- 100% offline capable thanks to ApplicationCache
- Stores mind maps in LocalStorage
-- Canvas API draws the mind map
- FileReader API reads stored mind maps from the hard drive
+- Canvas API draws the mind map
## Try it out
@@ -16,21 +16,9 @@ The latest stable build is hosted [here] (http://drichard.org/mindmaps).
Although the application runs fine if you launch `/src/index.html`, be aware that this is just the DEBUG mode for development. In debug mode quite a lot of output is sent to the console, ApplicationCache is deactivated and all script files are served individually and uncompressed.
If you plan to host the application please build it properly by running the build script.
-In order to build the application yourself you need to have node.js and a couple of modules installed.
-
-- [jake] (https://github.com/mde/jake): `npm install jake`
-- [wrench-js] (https://github.com/ryanmcgrath/wrench-js): `npm install wrench`
-- [uglify-js] (https://github.com/mishoo/UglifyJS): `npm install uglify-js`
+In order to build the application yourself you need to have node.js and a couple of modules installed. To install them simply run `npm install` in the root directory.
-
-Then run the jakefile:
-
-```
-cd /build
-jake
-```
-
-The finished build will appear in /bin.
+Then run the jakefile with `jake`. The finished build will appear in `/bin`.
## Host yourself
@@ -51,5 +39,7 @@ In nginx add this to conf/mime.types:
text/cache-manifest appcache;
```
+Alternatively, you can launch a local debug server with `npm start` which starts a server on localhost:8080.
+
## License
mindmaps is licensed under AGPL V3, see LICENSE for more information.

0 comments on commit 229c50a

Please sign in to comment.