From commits-return-52535-archive-asf-public=cust-asf.ponee.io@cordova.apache.org Mon Mar 5 21:12:47 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id E2F04180608 for ; Mon, 5 Mar 2018 21:12:46 +0100 (CET) Received: (qmail 73163 invoked by uid 500); 5 Mar 2018 20:12:44 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 73047 invoked by uid 99); 5 Mar 2018 20:12:44 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 05 Mar 2018 20:12:44 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id EE5E582620; Mon, 5 Mar 2018 20:12:43 +0000 (UTC) Date: Mon, 05 Mar 2018 20:12:43 +0000 To: "commits@cordova.apache.org" Subject: [cordova-docs] branch master updated: CB-13400: categorizing installations according to OSes (#802) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <152028076387.16550.14737047273298732562@gitbox.apache.org> From: janpio@apache.org X-Git-Host: gitbox.apache.org X-Git-Repo: cordova-docs X-Git-Refname: refs/heads/master X-Git-Reftype: branch X-Git-Oldrev: 582f6b928498f85a1621e69b25df7bf4fd755e39 X-Git-Newrev: 74f597ccb12da00b03706b405c4db2680dfe0a65 X-Git-Rev: 74f597ccb12da00b03706b405c4db2680dfe0a65 X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated This is an automated email from the ASF dual-hosted git repository. janpio pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cordova-docs.git The following commit(s) were added to refs/heads/master by this push: new 74f597c CB-13400: categorizing installations according to OSes (#802) 74f597c is described below commit 74f597ccb12da00b03706b405c4db2680dfe0a65 Author: Gandhirajan AuthorDate: Tue Mar 6 01:42:42 2018 +0530 CB-13400: categorizing installations according to OSes (#802) --- doc/installing-a-development-environment.md | 122 +++++++++++++++------------- 1 file changed, 65 insertions(+), 57 deletions(-) diff --git a/doc/installing-a-development-environment.md b/doc/installing-a-development-environment.md index 48f8a31..5020839 100644 --- a/doc/installing-a-development-environment.md +++ b/doc/installing-a-development-environment.md @@ -1,16 +1,34 @@ ## Installing -### Ruby +### Mac OS X -Ruby 2.0 is required to build the docs. NOTE: *The docs will not build with Ruby 1.8, 1.9 or 2.4.* - -#### Mac OS X +#### Ruby Install Homebrew from [this site][homebrew], and then run: brew install ruby@2.0 -#### Windows +#### Python + +Mac OS X comes with Python 2.7 pre-installed. Else, follow these steps: + +1. Download [this installer][python_installer_mac] from [this page][python_downloads]. +2. Run the downloaded file. + +#### Node.js + +Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to **install NPM** is enabled, if you see one. + +#### Make (optional) + +Make comes with the Xcode Command Line Tools. To install them, run: + + xcode-select --install + + +### Windows + +#### Ruby Follow these steps: @@ -31,57 +49,64 @@ Follow these steps: ruby dk.rb install 1. Close `cmd.exe`. -#### Linux - -Run the commands from [this site][ruby_linux] that apply to your Linux distribution. +#### Python -#### Verify Ruby +Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python 3.0 or greater.* -Verify your Ruby installation by running: +Follow these steps: - ruby --version +1. Download [this installer][python_installer_windows] from [this page][python_downloads]. +2. Run the downloaded file. + 1. Use the default installation path + 1. Make sure the **'add executable to path'** option is checked. -### Python +#### Node.js -Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python 3.0 or greater.* +Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to **install NPM** is enabled, if you see one. -#### Mac OS X +#### Make (optional) -Mac OS X comes with Python 2.7 pre-installed. Else, follow these steps: +Make can be installed on Windows from [this page][make_page] by downloading the [setup tool][make_setup] and running it. -1. Download [this installer][python_installer_mac] from [this page][python_downloads]. -2. Run the downloaded file. -#### Windows +### Linux -Follow these steps: +#### Ruby -1. Download [this installer][python_installer_windows] from [this page][python_downloads]. -2. Run the downloaded file. - 1. Use the default installation path - 1. Make sure the **'add executable to path'** option is checked. +Run the commands from [this site][ruby_linux] that apply to your Linux distribution. -#### Linux +#### Python The latest version of CentOS, Fedora, Redhat Enterprise (RHEL) and Ubuntu come with Python 2.7 pre-installed. Else, follow the steps from [this site][python_linux]. -#### Verify Python +#### Node.js -Verify your Python installation by running: +Follow the instructions on [this site][linux_node]. - python --version +#### Make -The version must be 2.7.x. +Make is installed by default on Linux. -### Node.js -#### Mac OS X & Windows +### Check Installations -Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to **install NPM** is enabled, if you see one. +#### Verify Ruby + +Ruby 2.0 is required to build the docs. NOTE: *The docs will not build with Ruby 1.8, 1.9 or 2.4.* + +Verify your Ruby installation by running: + + ruby --version + +#### Verify Python + +Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python 3.0 or greater.* -#### Linux +Verify your Python installation by running: -Linux, follow the instructions on [this site][linux_node]. + python --version + +The version must be 2.7.x. #### Verify Node.js @@ -90,6 +115,13 @@ Verify your Node.js installation by running: node --version npm --version +#### Verify make + +Verify your make installation by running: + + make --version + + ### Local repo setup Clone the [cordova-docs] GitHub repo to a local folder. @@ -111,30 +143,6 @@ Finally, install Node.js and JavaScript dependencies by running: npm install -### Make (optional) - -The website can be built with Gulp or Make. The Gulp workflow is enabled by just installing all the JavaScript dependencies. The Make workflow usually allows for faster builds, but requires installation of the `make` tool. - -#### Windows - -Make can be installed on Windows from [this page][make_page] by downloading the [setup tool][make_setup] and running it. - -#### Mac OS X - -Make comes with the Xcode Command Line Tools. To install them, run: - - xcode-select --install - -#### Linux - -Make is installed by default on Linux. - -#### Verify make - -Verify your make installation by running: - - make --version - ### Troubleshooting -- To stop receiving notification emails like this one, please contact janpio@apache.org. --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org For additional commands, e-mail: commits-help@cordova.apache.org