diff --git a/README.md b/README.md index 8b1a2a308d..971d790874 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,23 @@ Shared resources useful for the multiple HabitRPG repositories, that way all the * Assets - sprites, images, etc * CSS - especially, esp. sprite-sheet mapping * Algorithms - level up algorithm, scoring functions, etc - * Item definitions - weapons, armor, pets + * Item definitions - weapons, armor, pets You only need to include algos.coffee It will include the rest as necessary. -Note how to invoke scoring function: - * algos.score = function (user, task, direction) {} + ##Installation - * Node.js - just include as usual. - * Browser - use requre.js with "cs" plugin to include files directly into your index.html see require.js-example folder. (run plain http-server from within equire.js-example folder and point your browser to index.html to see how it works) +* Reqire files + * Node.js - just include algos.coffee as usual. + * Browser - use requre.js with "cs" plugin to include algos.coffee directly into your index.html + * See require.js-example folder. + * Run plain http-server from within "equire.js-example" folder and point your browser to index.html to see how it works. (it should alert message in CAPS) + +* Note how to invoke scoring function: + * algos.score = function (user, task, direction) {} ##CSS Shared CSS between the website and the mobile app is a fuzzy area. For now we'll have the website define canonical CSS, and share that down the mobile app.