Permalink
Browse files

updated docs

  • Loading branch information...
1 parent 0e9ddc2 commit b5835f3bc62ddca09c560db97eeed5530b5980ff @dethe committed Oct 27, 2012
Showing with 6 additions and 6 deletions.
  1. +3 −3 index.html
  2. +3 −3 readme.md
View
@@ -19,7 +19,7 @@
<li>Create a <code>bloqs</code> subdirectory for your markdown files</li>
<li>Copy the js and styles for documentation files: <code>cp -r node_modules/obloq/lib .</code></li>
<li>To support Less, Handlebars, Stylus, Coffescript, Jade, and more, install the grunt-contrib tasks: <code>npm install grunt-contrib</code></li>
-<li>Run <code>grunt</code> to extract code blocks to a <code>build</code> directory and documentation to <code>docs</code></li>
+<li>Run <code>grunt</code> to extract code blocks to a <code>build</code> directory, documentation to <code>docs</code>, templates and concatenated, minified files to <code>web</code>.</li>
</ol>
<p><strong>Warning</strong> The default grunt task will erase all files in <code>docs</code>, <code>build</code>, and <code>web</code> each time it is run. Only use these directories for generated files! The default task also assumes grunt-contrib is installed, although it isn't strictly required for oBloq.</p>
@@ -51,7 +51,7 @@
avatar x y w h # draws a rectangle with a very rough sketch of a person. Needs work.
``` text
-For example (example works on [http://dethe.github.com/obloq/ Github page], but not in code view):
+For example (example works on [Github page](http://dethe.github.com/obloq/), but not in code view):
``` text
size 400 200
@@ -94,7 +94,7 @@
<ul>
<li>Build list of classes used and in which bloqs (need to parse html templates)</li>
<li>Build list of IDs used and in which bloqs (ditto)</li>
-<li>Build list of events emitted and in which bloqs (need to parse JS: use [<a href="http://marijnhaverbeke.nl/acorn/">http://marijnhaverbeke.nl/acorn/</a> Acorn] parser?)</li>
+<li>Build list of events emitted and in which bloqs (need to parse JS: use <a href="http://marijnhaverbeke.nl/acorn/">Acorn</a> parser?)</li>
<li>Build list of events listened for and in which bloqs (ditto)</li>
<li>Build list of functions defined and in which bloqs (ditto)</li>
<li>Build list of functions called? (ditto)</li>
View
@@ -18,7 +18,7 @@ oBloq was developed around the idea of "card-based programming," which is that m
4. Create a `bloqs` subdirectory for your markdown files
5. Copy the js and styles for documentation files: `cp -r node_modules/obloq/lib .`
6. To support Less, Handlebars, Stylus, Coffescript, Jade, and more, install the grunt-contrib tasks: `npm install grunt-contrib`
-7. Run `grunt` to extract code blocks to a `build` directory and documentation to `docs`
+7. Run `grunt` to extract code blocks to a `build` directory, documentation to `docs`, templates and concatenated, minified files to `web`.
**Warning** The default grunt task will erase all files in `docs`, `build`, and `web` each time it is run. Only use these directories for generated files! The default task also assumes grunt-contrib is installed, although it isn't strictly required for oBloq.
@@ -50,7 +50,7 @@ rtext x y text # draws text right justified and ending at x y
avatar x y w h # draws a rectangle with a very rough sketch of a person. Needs work.
``` text
-For example (example works on [http://dethe.github.com/obloq/ Github page], but not in code view):
+For example (example works on [Github page](http://dethe.github.com/obloq/), but not in code view):
``` text
size 400 200
@@ -91,7 +91,7 @@ There is no specific support, but oBloq can be used to document Ajax paths, URL
* Build list of classes used and in which bloqs (need to parse html templates)
* Build list of IDs used and in which bloqs (ditto)
-* Build list of events emitted and in which bloqs (need to parse JS: use [http://marijnhaverbeke.nl/acorn/ Acorn] parser?)
+* Build list of events emitted and in which bloqs (need to parse JS: use [Acorn](http://marijnhaverbeke.nl/acorn/) parser?)
* Build list of events listened for and in which bloqs (ditto)
* Build list of functions defined and in which bloqs (ditto)
* Build list of functions called? (ditto)

0 comments on commit b5835f3

Please sign in to comment.