From 77f305d87ab3ce4d9a92fec43a184a24ca1d9d0d Mon Sep 17 00:00:00 2001 From: Chuck Lantz Date: Mon, 17 Aug 2015 16:25:53 -0700 Subject: [PATCH] Update README.md --- tutorial-team-build/README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/tutorial-team-build/README.md b/tutorial-team-build/README.md index 42025d6c..7e611943 100644 --- a/tutorial-team-build/README.md +++ b/tutorial-team-build/README.md @@ -8,14 +8,14 @@ In this tutorial, we will cover how you can get your project running in nearly a ##Walkthrough To get going quickly, follow these steps: -1. First, either install Visual Studio with the Tools for Apache Cordova option on your build server or simply install the pre-requisites for the platforms you are targeting separately. In brief: +1. **Install dependencies:** First, either install Visual Studio with the Tools for Apache Cordova option on your build server or simply install the pre-requisites for the platforms you are targeting separately. In brief: - Visual Studio itself is **only** required if you are building for **Windows or Windows Phone**. - Install [Node.js](http://go.microsoft.com/fwlink/?LinkID=396867) and you'll also need to install the [Git command line tools](http://go.microsoft.com/fwlink/?LinkID=396870) on Windows. Note that the default option for Git's install does not place the tools in the path. Select option to run the tools from the command prompt. - **Android** requires the [Java](http://go.microsoft.com/fwlink/?LinkID=396871), [Ant](http://go.microsoft.com/fwlink/?LinkID=396869) (Cordova < 5.0.0 only), and the [Android SDK](http://go.microsoft.com/fwlink/?LinkID=533747) with the correct API level installed (usually API 21 or 22). Add environment variables for ANDROID_HOME pointing to your Android SDK install, ANT_HOME to your Ant install, and JAVA_HOME to your Java install. Add %ANT_HOME%\bin to your path. - **iOS** requires Xcode (from the Mac app store) and [Node.js](http://go.microsoft.com/fwlink/?LinkID=396867) - See the [General CI tutorial](./General.md#depends) or [Install Dependencies Manually](https://msdn.microsoft.com/en-us/library/dn771551.aspx) in MSDN for some information on what to install for a given platform. -2. Add these lines to a package.json file in your project. Use [this version](https://github.com/Chuxel/taco-team-build/blob/master/samples/gulp/package.json) if you do not yet have a package.json file in the root of your project. +2. **Update package.json in your project:** Add these lines to a package.json file in your project. Use [this version](https://github.com/Chuxel/taco-team-build/blob/master/samples/gulp/package.json) if you do not yet have a package.json file in the root of your project. ~~~~~~~~~~~~~~~~~~~~~~~~~~ { @@ -27,11 +27,11 @@ To get going quickly, follow these steps: } ~~~~~~~~~~~~~~~~~~~~~~~~~~ -3. Add [this Gulp file](https://github.com/Chuxel/taco-team-build/blob/master/samples/gulp/gulpfile.js) to the root of your project +3. **Add a gulpfile to your project:** Add [this Gulp file](https://github.com/Chuxel/taco-team-build/blob/master/samples/gulp/gulpfile.js) to the root of your project ![gulpfile.js in project]() -4. Test out your build by dropping to the command line, and running the following commands from the root of your Cordova project (not the solution root): +4. **Try it locally:** Test out your build by dropping to the command line, and running the following commands from the root of your Cordova project (not the solution root): ~~~~~~~~~~~~~~~~~~~~~~~~~~ npm install @@ -45,8 +45,6 @@ To get going quickly, follow these steps: ./node_modules/.bin/gulp ~~~~~~~~~~~~~~~~~~~~~~~~~~ - You can also install Gulp globally (npm install -g gulp) and omit "node_modules\\.bin" from the command above. - Gulp will now build Android, Windows, and Windows Phone 8 versions of your project when run from Windows and iOS when run from OSX. You can change this behavior by updating the following lines in gulpfile.js. ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -55,11 +53,11 @@ To get going quickly, follow these steps: ... ~~~~~~~~~~~~~~~~~~~~~~~~~~ -5. Assuming all goes well, add your project into the appropriate source code repository. +5. **Add to source control:** Assuming all goes well, add your project into the appropriate source code repository. -6. Next, configure your Team / CI server to fetch your project and execute the exact same commands mentioned above from the root of your Cordova project after fetching the source code. +6. **Configure CI:** Next, configure your Team / CI server to fetch your project and execute the exact same commands mentioned above from the root of your Cordova project after fetching the source code. You can find detailed instructions for certain CI systems [below](#ci). -7. Finally, configure an build agent / slave on both Windows and OSX so you can build for any platform. See the tutorials below for some specifics on how to configure your CI system. +7. **Windows & OSX Build Agents:** Finally, configure an build agent / slave on both Windows and OSX so you can build for any platform. See the tutorials below for some specifics on how to configure your CI system. That's it!