From 7f1e2e48467f80cc083d24b44f088620e4e7bcb6 Mon Sep 17 00:00:00 2001 From: Igor Minar Date: Mon, 6 Jun 2011 08:50:35 -0700 Subject: new batch of docs --- docs/content/tutorial/index.ngdoc | 187 +++++++++++++++++++++++--------------- 1 file changed, 114 insertions(+), 73 deletions(-) (limited to 'docs/content/tutorial/index.ngdoc') diff --git a/docs/content/tutorial/index.ngdoc b/docs/content/tutorial/index.ngdoc index 4b10401a..eb4c7e11 100644 --- a/docs/content/tutorial/index.ngdoc +++ b/docs/content/tutorial/index.ngdoc @@ -38,14 +38,14 @@ When you finish the tutorial you will be able to: * Identify resources for learning more about angular -Mac and Linux users can work through the tutorial, run tests, and experiment with the code using -Git or the snapshots described below. Windows users will be able read the tutorial but won't be -able to run the tests or experiment with the code. +The tutorial is will guide you through the process of building a simple application, including +writing and running unit and end-to-end tests, and will allow you to experiment with angular and +the application through experiments suggested at the end of each step. You can go through the whole tutorial in a couple of hours or you may want to spend a pleasant day -really digging into it. If you're looking for a shorter introduction to angular, check out {@link -http://docs.angularjs.org/#!started started}. +really digging into it. If you're looking for a shorter introduction to angular, check out the +{@link misc/started Getting Started} document. @@ -54,21 +54,8 @@ http://docs.angularjs.org/#!started started}. - -# Prerequisites -To run the tutorial app and tests on your machine you will need the following: - - -* A Mac or Linux machine (required for running the tutorial scripts) -* An http server running on your system. Mac and Linux machines typically have Apache preinstalled. -If you don't already have an http server installed, you can install `node.js` ({@link -https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager node.js install guide}) -or another http sever. -* {@link http://java.com Java}. -* A web browser. -* A text editor. @@ -76,59 +63,113 @@ or another http sever. # Working with the code -There are two ways that you can you follow this tutorial and hack on the code: - - -## Using Git - - -The following instructions are for Git users. If you're not a Git user, skip down to the "Using -Snapshots" section. - - -1. Check to be sure you have all of the prerequisites on your system. - - -2. Clone the angular-phonecat repository located at {@link -https://github.com/angular/angular-phonecat GitHub} by running the following command in a terminal: - - - git clone git://github.com/angular/angular-phonecat.git - - - This will create a directory called `angular-phonecat` in the current directory. - - -3. Change your current directory to `angular-phonecat`. - - - cd angular-phonecat - - - The tutorial instructions assume you are running all commands from this directory. - - - - -## Using Snapshots - - -1. Check to be sure you have all of the prerequisites on your system. - - -2. {@link http://code.angularjs.org/angular-phonecat-snapshots.zip Download the zip archive} with -all files and unzip them into `[tutorial-dir]` directory. - - - - -3. Change directories to `[tutorial-dir]/sandbox`. - - - cd [tutorial-dir]/sandbox - - - - -Let's get going with {@link tutorial/step_00 step 0}. +There are two ways that you can you follow this tutorial and hack on the code, both available on +Mac/Linux or Windows environment. The first work flow uses Git versioning system for source code +management, the second work flow doesn't depend on any source control system and instead uses +scripts to copy snapshots of project files into your workspace (`sandbox`) directory. Choose the +one you prefer: + + + + +
    +

  1. Verify that you have Java installed by running the +following command in a terminal window:

    + 
    java -version
    +

    You will need Java to run unit tests.

    2. +

  2. Get Git from here

    +

    You can build it from source or use pre-compiled package.

    3. +

  3. Clone the angular-phonecat repository located at Github by running this command:

    + 
    git clone git://github.com/angular/angular-phonecat.git
    +

    This will create angular-phonecat directory in current directory.

    4. +

  4. Change your current directory to angular-phonecat:

    + 
    cd angular-phonecat
    +

    The tutorial instructions assume you are running all commands from this directory.

    5. +

  5. You'll also need an http server running on your system. Mac and Linux machines +typically have Apache preinstalled.

    +

    If you don't already have an http server installed, you can install +node.js and use it to run scripts/web-server.js — a simple bundled http +server.

    6. +
+ + + + +
    +

  1. Verify that you have Java installed and that the +java executable is on your PATH by running this command in windows +command line:

    + 
    java -version
    +

    You will need Java to run unit tests.

    2. +

  2. Install msysGit from here

    3. +

  3. Open msysGit bash and clone the angular-phonecat repository located at Github by running this command:

    + 
    git clone git://github.com/angular/angular-phonecat.git
    +

    This will create angular-phonecat directory in your current directory.

    4. +

  4. Change your current directory to angular-phonecat:

    + 
    cd angular-phonecat
    +

    The tutorial instructions assume you are running all commands from this directory.

    +

    You should run all git commands from msysGit bash.

    +

    Other commands like test-server.bat or test.bat that will be +introduced soon, should be executed from the windows command line.

    5. +

  5. You'll also need an http server running on your system.

    +

    If you don't already have an http server installed, you can install node.js. Just download pre-compiled binaries, unzip them and add +nodejs\bin into your PATH and use node to run +scripts\web-server.js — a simple bundled http server.

    6. +
+ + + + +
    +

  1. Verify that you have Java installed by running the +following command in a terminal window:

    + 
    java -version
    +

    You will need Java to run unit tests.

    2. +

  2. Download the zip archive +with all files and unzip them into [tutorial-dir] directory

    3. +

  3. Change your current directory to [tutorial-dir]/sanbox:

    + 
    cd [tutorial-dir]/sandbox
    +

    The tutorial instructions assume you are running all commands from this directory.

    4. +

  4. You'll also need an http server running on your system. Mac and Linux machines +typically have Apache preinstalled.

    +

    If you don't already have an http server installed, you can install +node.js and use it to run scripts/web-server.js — a simple bundled http +server.

    5. +
+ + + + +
    +

  1. Verify that you have Java installed and that the +java executable is on your PATH by running this command in windows +command line:

    + 
    java -version
    +

    You will need Java to run unit tests.

    2. +

  2. Download the zip archive +with all files and unzip them into [tutorial-dir] directory

    3. +

  3. Change your current directory to [tutorial-dir]/sanbox:

    + 
    cd [tutorial-dir]/sandbox
    +

    The tutorial instructions assume you are running all commands from this directory.

    4. +

  4. You'll also need an http server running on your system.

    +

    If you don't already have an http server installed, you can install node.js. Just download pre-compiled binaries, unzip them and add +nodejs\bin into your PATH and use node to run +scripts\web-server.js — a simple bundled http server.

    5. +
+ + + + +For either work flow you'll also need a web browser and your favorite text editor. + + +Let's get going with {@link step_00 step 0}. -- cgit v1.2.3