Skip to content

Commit 5609909

Browse files
committed
readme updates
1 parent 1d24f54 commit 5609909

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
11
Example of using jQuery and require.js with a shim config.
22
====
33

4-
This example shows one way to load jQuery and jQuery plugins with require.js. jQuery itself registers as an AMD module and can easily be loaded. Most plugins, however, does not register as AMD modules, and therefore, require.js doesn't know that the plugins need jQuery to be loaded.
4+
This example shows one way to load jQuery and jQuery plugins with require.js. jQuery itself registers as an AMD module and can easily be loaded. Most plugins, however, does not register as AMD modules, and therefore, require.js doesn't know that the plugins need jQuery to be loaded.
55

6-
The most important part is the app.js file, which specifies the [shim configuration](http://requirejs.org/docs/api.html#config-shim) for the plugins.
6+
The most important part is the app.js file, which specifies the [shim configuration](http://requirejs.org/docs/api.html#config-shim) for the plugins.
77

8-
###Project structure
8+
###Project structure
99

1010
- tools/
1111
- build.js
1212
- r.js
13-
1413
- www/
1514
- app.html
1615
- js/
17-
- app.js
18-
- lib/
19-
- jquery.js
20-
- jquery.alpha.js
21-
- jquery.beta.js
22-
- require.js
23-
- app/
24-
- main.js
16+
- app.js
17+
- lib/
18+
- jquery.js
19+
- jquery.alpha.js
20+
- jquery.beta.js
21+
- require.js
22+
- app/
23+
- main.js
2524

2625
###How it's set up
2726
The main file of this setup is www/js/app.js. It is loaded from app.html by this line:
@@ -60,10 +59,10 @@ define(["jquery", "jquery.alpha", "jquery.beta"], function($) {
6059

6160
###How to see it in action
6261

63-
Just serve up the www/ folder using any web server you'd like. If you have python installed, an easy way is to navigate into the www/ directory and type `python -m SimpleHTTPServer`
62+
Just serve up the www/ folder using any web server you'd like.
6463

6564
###How to optimize ut using r.js
6665
To use the optimizer, you need [node.js](http://nodejs.org) or Java 6 installed. These instructions assume Node is being used. See the [Optimization page](http://requirejs.org/docs/optimization.html) for more information.
67-
66+
6867
r.js and a build configuration is included in the tools/ folder. To build, navigate to tools/ and type `node r.js -o build.js`. You will find the built product in the www-build folder. If you serve that directory instead, you can see in the network panel of the web developer tools that the files aren't loaded separately any more.
6968

0 commit comments

Comments
 (0)