From 3e54a1b18ab698d55e1642a120f95ea3adf6af1b Mon Sep 17 00:00:00 2001 From: Igor Minar Date: Fri, 29 Jul 2011 12:40:14 -0700 Subject: doc(tutorial): fixes and improvements from Toni and Ben --- docs/content/tutorial/index.ngdoc | 159 +++++++++++++++++++------------------- 1 file changed, 79 insertions(+), 80 deletions(-) (limited to 'docs/content/tutorial/index.ngdoc') diff --git a/docs/content/tutorial/index.ngdoc b/docs/content/tutorial/index.ngdoc index 605bccd3..c26ea2df 100644 --- a/docs/content/tutorial/index.ngdoc +++ b/docs/content/tutorial/index.ngdoc @@ -2,40 +2,40 @@ @name Tutorial @description -A great way to get introduced to angular is to work through this tutorial, which walks you through -the construction of an angular web app. The app you will build is a catalog that displays a list of -Android devices, lets you filter the list to see only devices that interest you, and then view +A great way to get introduced to Angular is to work through this tutorial, which walks you through +the construction of an AngularJS web app. The app you will build is a catalog that displays a list +of Android devices, lets you filter the list to see only devices that interest you, and then view details for any device. -As you work through this tutorial, you will learn how angular makes browsers smarter — without the -use of extensions or plugins. +Work through the tutorial to see how Angular makes browsers smarter — without the use of extensions +or plug-ins. As you work through the tutorial, you will: -* You will see examples of how to use client-side data binding and dependency injection to build -dynamic views of data that change immediately in response to user actions. -* You will see how angular creates listeners on your data without the need for DOM manipulation. -* You will learn a better, easier way to test your web apps. -* You will learn how to use angular services to make common web tasks, such as getting data into -your app, easier. +* See examples of how to use client-side data binding and dependency injection to build dynamic +views of data that change immediately in response to user actions. +* See how Angular creates listeners on your data without the need for DOM manipulation. +* Learn a better, easier way to test your web apps. +* Learn how to use Angular services to make common web tasks, such as getting data into your app, +easier. -And all of this works in any browser without modifications! +And all of this works in any browser without modification to the browser! When you finish the tutorial you will be able to: -* Create a dynamic application that works in any browser -* Define the differences between angular and common JavaScript frameworks -* Understand how data binding works in angular -* Use the angular-seed project to quickly boot-strap your own projects -* Create and run tests -* Identify resources for learning more about angular +* Create a dynamic application that works in any browser. +* Define the differences between Angular and common JavaScript frameworks. +* Understand how data binding works in AngularJS. +* Use the angular-seed project to quickly boot-strap your own projects. +* Create and run tests. +* Identify resources for learning more about AngularJS. -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. +The tutorial guides you through the entire process of building a simple application, including +writing and running unit and end-to-end tests. Experiments at the end of each step provide +suggestions for you learn more about AngularJS and the application you are building. 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 the +really digging into it. If you're looking for a shorter introduction to AngularJS, check out the {@link misc/started Getting Started} document. @@ -46,11 +46,11 @@ really digging into it. If you're looking for a shorter introduction to angular, # Working with the code -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: +You can follow this tutorial and hack on the code in either the Mac/Linux or the Windows +environment. Options for working with the tutorial are to use the Git versioning system for source +code management or to use scripts that copy snapshots of project files into your workspace +(`sandbox`) directory. Select one of the tabs below and follow the instructions for setting up your +computer for your preferred option. @@ -59,67 +59,68 @@ one you prefer: following command in a terminal window:

java -version

You will need Java to run unit tests.

-

  • Get Git from here

    -

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

    • +

  • Download Git from the Git site.

    +

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

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

    +href="https://github.com/angular/angular-phonecat">Github by running the following command:

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

    This will create angular-phonecat directory in current directory.

    • +

    This command creates the angular-phonecat directory in your current +directory.

  • Change your current directory to angular-phonecat:

    cd angular-phonecat
    -

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

    • -

  • 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 The tutorial instructions assume you are running all commands from the angular-phonecat +directory.

    • +

  • You will need an http server running on your system. Mac and Linux machines typically +have Apache pre-installed, but If you don't already have one installed, you can install -node.js and use it to run scripts/web-server.js — a simple bundled http -server.

    • +node.js. Use node to run scripts/web-server.js, a simple bundled +http server.
      -

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

      +

    2. You will need Java to run unit tests, so run the following command to verify that you +have Java installed and that the java executable is on +your PATH.

      java -version
      -

      You will need Java to run unit tests.

      3. -

    3. Install msysGit from here

      4. +

      +

    4. Install msysGit from the Git site.

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

      +href="https://github.com/angular/angular-phonecat">Github by running the following command:

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

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

      6. -

    6. Change your current directory to angular-phonecat:

      +

      This command creates the angular-phonecat directory in your current directory.

      7. +

    7. Change your current directory to angular-phonecat.

      cd angular-phonecat
      -

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

      +

      The tutorial instructions assume you are running all commands from the angular-phonecat +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.

      8. -

    8. 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.

      9. +

      Other commands like test-server.bat or test.bat should be +executed from the Windows command line. +

    9. You need an http server running on your system. If you don't already have one +installed, you can install node.js. Download the pre-compiled binaries, unzip them, and then add +nodejs\bin into your PATH. Use node to run +scripts\web-server.js, a simple, bundled http server.
      -

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

      +

    2. You need Java to run unit tests, so 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.

      3. -

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

      4. -

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

      +

    5. Download the zip archive +containing all of the files and unzip them into the [tutorial-dir] directory

      .
      6. +

    6. Change your current directory to [tutorial-dir]/sandbox, as follows:

      cd [tutorial-dir]/sandbox
      -

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

      7. -

    7. 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 The tutorial instructions assume you are running all commands from your +sandbox directory.

      8. +

    8. You need an http server running on your system and Mac and Linux machines typically +have Apache pre-installed. If you don't have an http server installed, you can install -node.js and use it to run scripts/web-server.js — a simple bundled http +node.js and use it to run scripts/web-server.js, a simple bundled http server.

     @@ -127,25 +128,23 @@ server.

    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 executable is on your PATH by running the following command in the +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:

      +

      You need Java to run unit tests, so download the zip archive that contains all of the files +and unzip the files into the [tutorial-dir] directory

      4. +

    4. Change your current directory to [tutorial-dir]/sandbox, as follows:

      cd [tutorial-dir]/sandbox

      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.

      -

      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. +

    6. You need an http server running on your system, but if you don't already have one +already installed, you can install node.js. Download the pre-compiled binaries, unzip them, and then add +nodejs\bin into your PATH. Use node to run +scripts\web-server.js, a simple bundled http server.

         -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}. +The last thing to do is to make sure your computer has a web browser and a good text editor +installed. Now, let's get going with {@link step_00 step 0}. -- cgit v1.2.3