Skip to content
This repository has been archived by the owner on Dec 31, 2017. It is now read-only.

Commit

Permalink
Update 1.7 branch readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
csnover committed Dec 28, 2011
1 parent fde4faa commit 84f1625
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Expand Up @@ -4,7 +4,7 @@ The Dojo Boilerplate is a set of files to help you rapidly get up and running
with the Dojo Toolkit. It illustrates some basic best practices when working
with Dojo. This is the branch for the new Dojo 1.7 loader and build systems,
which use AMD modules; there is also a [branch using the old synchronous
loader](https://github.com/rmurphey/dojo-boilerplate/tree/master), for use
loader](https://github.com/csnover/dojo-boilerplate/tree/1.6), for use
with Dojo 1.6.

Huge thanks go out to [neonstalwart](https://github.com/neonstalwart) for his
Expand All @@ -16,11 +16,10 @@ providing guidance for earlier versions of the AMD branch.
## Quick Start

0. Clone the repository using `git clone --recursive`.
1. Check out the AMD 1.7 branch using `git checkout amd1.7`.
2. Develop your project in `src/` until it is amazing.
3. Run `util/build.sh`, which will create an awesome optimised build in `dist/`.
4. Upload `dist/` for millions of people the world over to enjoy.
5. Hapyness.
1. Develop your project in `src/` until it is amazing.
2. Run `build.sh`, which will create an awesome optimised build in `dist/`.
3. Upload `dist/` for millions of people the world over to enjoy.
4. Hapyness.

### Windows Users

Expand All @@ -41,27 +40,27 @@ much faster builds.
the client, and `src/server.sh` for a server running Node.js. These files
are responsible for loading the Dojo loader and the application’s
bootstrapper script.
* The file `src/js/boot.js` is your application’s bootstrapper script. In
* The file `src/app/run.js` is your application’s bootstrapper script. In
it, you can configure paths, packages, and other configuration options
that should apply to both the client and the server. By default, this file
simply configures paths and packages and then loads `src/js/app/main.js`
simply configures paths and packages and then loads `src/app/main.js`
(by way of the second `[ 'app' ]` argument).
* The file `util/build.sh` takes your application files and builds them for
* The file `build.sh` takes your application files and builds them for
production use using the Dojo build tool. It depends on the presence of the
build profile at `profiles/main.profile.js`.
* The file `src/js/app/resources/app.css` contains import statements to load
build profile at `src/app/app.profile.js`.
* The file `src/app/resources/app.css` contains import statements to load
the CSS for Dojo’s Claro theme. _If you are not using Dijit widgets, you
probably want to remove these imports!_
* The directory `src/js/dbp` contains tools you may find useful. These tools
* The directory `src/dbp` contains tools you may find useful. These tools
are a work in progress, and are not yet updated to AMD syntax.


Useful resources
----------------

* [Dojo Reference Guide](http://dojotoolkit.org/reference-guide/)
* [Dojo Reference Guide (latest release version)](http://dojotoolkit.org/reference-guide/)
* [Introduction to Custom Dojo Widgets](http://www.enterprisedojo.com/2010/09/21/introduction-to-custom-dojo-widgets/)
* [Dojo Campus](http://docs.dojocampus.org/)
* [Dojo Reference Guide (Dojo trunk)](http://livedocs.dojotoolkit.org/)

License
-------
Expand Down

0 comments on commit 84f1625

Please sign in to comment.