aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guide.downloading.ngdoc
diff options
context:
space:
mode:
authorJanet Davies2011-02-08 14:36:18 -0800
committerMisko Hevery2011-02-09 11:19:30 -0800
commitc1caf2560a39d3e9bb249877c8fd58464ad91f99 (patch)
treec3e7aa20c556bc131ad4987c7a5f17c90dc342c6 /docs/guide.downloading.ngdoc
parentb07cc0e392ee1a856ee6f4d88cb6888cdfacdc93 (diff)
downloadangular.js-c1caf2560a39d3e9bb249877c8fd58464ad91f99.tar.bz2
Update Dev Guide Downloading content (to be moved to Contributing later).
Diffstat (limited to 'docs/guide.downloading.ngdoc')
-rw-r--r--docs/guide.downloading.ngdoc40
1 files changed, 16 insertions, 24 deletions
diff --git a/docs/guide.downloading.ngdoc b/docs/guide.downloading.ngdoc
index 9f0f2194..d5963337 100644
--- a/docs/guide.downloading.ngdoc
+++ b/docs/guide.downloading.ngdoc
@@ -3,33 +3,25 @@
@name Developer Guide: Downloading
@description
-# Downloading
-Follow these steps to download, compile, and host angular.js on your own server:
+# Downloading
+To host `angular` on your server, you need RAKE and you need the
+`angular` source code. The steps below explain how to download and compile these
+required software products:
-## Step 0
+1. To install RAKE (Ruby Make), download the installation file from
+{@link http://rake.rubyforge.org/}.
-If you don't already have Rake (Ruby Make) installed, download and install it from
-http://rake.rubyforge.org/.
+2. To install the `angular` source code, download the source code from
+{@link http://github.com/angular/angular.js}.
-## Step 1
+3. To compile the source, run the command `rake compile` (the `angular` source
+code includes a Rakefile).
-Download the angular source code from GitHub: http://github.com/angular/angular.js.
+The `js` directory contains the following versions of the `angular` bootstrap
+code:
-## Step 2
+* `angular-?.?.?.js` - This file is unobfuscated, uncompressed, and
+can be read.
-The source code should include a Rakefile. Compile the source by typing rake compile.
-
-## Step 3
-
-Host the files on your server. Look through your source tree and make sure that the css and js
-directories are parallel (i.e. share a common root node).
-
-In the js directory you should see these different versions of the angular bootstrap code:
-
-* **angular-?.?.?.js** - this file is unobfuscated, uncompressed, and human-readable. Note that
- despite the name of the file, there is no additional functionality built in to help you debug
- your application; it has the prefix debug because you can read the source code.
-* **angular-?.?.?.min.js** - this is a compressed and obfuscated version of `angular-?.?.?.js`.
- You might want to use this version if you want to load a smaller but functionally equivalent
- version of the code in your application. Note: this minified version was created using the
- Closure Compiler.
+* `angular-?.?.?.min.js` - This is a compressed and obfuscated version of
+`angular-?.?.?.js` created with Closure Compiler. Use this version for production and to minimize the size of the application that is downloaded by the user.