Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added CoffeeScript instructions and jQuery version to Readme.

  • Loading branch information...
commit cc7b31976b40e28477f7cd7199372cac14a2027a 1 parent 56da937
@quartzmo authored
Showing with 5 additions and 3 deletions.
  1. +5 −3 Readme.md
View
8 Readme.md
@@ -4,17 +4,19 @@ This is a minimalistic boilerplate for a browser-based CoffeeScript project that
The Mocha tests use the [Chai](https://github.com/chaijs/chai) assertion library for browser compatibility.
The CoffeeScript `coffee` executable is required for source and test compilation. Once the CoffeeScript is compiled, CoffeeScript is **not** required for the browser-based tests, which are run simply by opening `test/index.html` with a modern browser.
-## Library versions
+## Included library versions
* Chai: 1.2.0
-* jQuery:
+* CoffeeScript: not included
+* jQuery: 1.8.2
* Mocha: 1.6.0
## Usage
To use this boilerplate to start your own project:
+1. Install CoffeeScript per the [official instructions](http://jashkenas.github.com/coffee-script/#installation).
1. `rm -rf .git`
1. Replace `example.coffee` in both `test` and `src` with your own code.
1. `make` to compile source and test CoffeeScript, or else `make watch` and `make test-watch` for automatic compilation
-1. Edit `Readme.md`, replacing this project's details with your own.
+1. Edit `Readme.md` and `LICENSE`, replacing this project's details with your own.
Please sign in to comment.
Something went wrong with that request. Please try again.