Permalink
Browse files

Added example readme file

  • Loading branch information...
1 parent acea313 commit 0951ef0d8a77974c4cce452d65ab3b4ff242ba9d @asciidisco committed Feb 7, 2013
Showing with 52 additions and 0 deletions.
  1. +52 −0 examples/almond-text-plugin-singlefile/README.md
@@ -0,0 +1,52 @@
+# grunt-requirejs/example/almond-text-plugin-singlefile
+
+> This project shows how to set up a singlefile requirejs-based project that has the following goals:
+
+*
+
+## Installation
+
+Clone the git-repo or download this project and run `npm install`.
+It fetches all the needed node dependecies as well as the frontend vendor libs using volo.
+
+## Project layout
+
+This project has the following layout:
+
+* **src**: The code that runs in the browser while in development mode.
+* **dist**: Generated after an optimizer build. Contains the built code that can be deployed to the live site.
+* **node_modules**:
+* **.editorconfig**:
+* **.jshintrc**:
+* **Gruntfile.js**:
+* **package.json**:
+
+This **src** has the following layout:
+
+* **index.html**: The index page
+* **js**
+ * **app**: the directory to store app-specific modules.
+ * **lib**: the directory to hold third party modules, like jQuery.
+ * **main.js**: contains the requirejs config, and it will be the build target for the set of common modules.
+
+To optimize, run:
+
+ `grunt`
+
+That build command creates an optimized version of the project in a
+**dist** directory.
+
+
+## More info
+
+For more information on the optimizer:
+http://requirejs.org/docs/optimization.html
+
+For more information on using requirejs:
+http://requirejs.org/docs/api.html
+
+For more information on grunt:
+http://gruntjs.org
+
+For more information on volo:
+http://volojs.org

0 comments on commit 0951ef0

Please sign in to comment.