From d35baac05463c3889c138f4f101178e36f4e8483 Mon Sep 17 00:00:00 2001 From: Corey Johnson Date: Thu, 8 May 2014 16:16:13 -0700 Subject: [PATCH 1/5] Add build instructions section to docs folder --- docs/advanced/build-instructions.md | 64 +++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/advanced/build-instructions.md diff --git a/docs/advanced/build-instructions.md b/docs/advanced/build-instructions.md new file mode 100644 index 00000000000..c844fb48ce5 --- /dev/null +++ b/docs/advanced/build-instructions.md @@ -0,0 +1,64 @@ +* [Linux instructions](#linux) +* [OS X instructions](#os-x) +* [Windows instructions](#windows) + +# Linux + +Ubuntu LTS 12.04 64-bit is the recommended platform. + +#### Requirements + + * OS with 64-bit architecture + * [node.js](http://nodejs.org/download/) v0.10.x + * [npm](http://www.npmjs.org/) v1.4.x + * libgnome-keyring-dev `sudo apt-get install libgnome-keyring-dev` + * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2 + +#### Instructions + + ```sh + git clone https://github.com/atom/atom + cd atom + script/build # Creates application at /tmp/atom-build/Atom + sudo script/grunt install # Installs command to /usr/local/bin/atom + script/grunt mkdeb # Generates a .deb package at /tmp/atom-build + ``` + +# OS X + +#### Requirements + + * OS X 10.8 or later + * [node.js](http://nodejs.org/download/) v0.10.x + * Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install) + +#### Instructions + + ```sh + git clone https://github.com/atom/atom + cd atom + script/build # Creates application at /Applications/Atom.app + ``` + +# Windows + +#### Requirements + + * Windows 7 or later + * [Visual C++ 2010 SP1 Express](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#DownloadFamilies_4) + * [node.js - 32bit](http://nodejs.org/download/) v0.10.x + * [Python 2.7.x](http://www.python.org/download/) + * [GitHub for Windows](http://windows.github.com/) + * [Git for Windows](http://git-scm.com/download/win) + * Select the option **Use Git from the Windows Command Prompt** when installing (Git needs to be in your `PATH`) + * Add `C:\Python27;C:\Program Files\nodejs;C:\Users\\github\atom\node_modules\` + to your PATH + +#### Instructions + + ```bat + cd C:\Users\\github + git clone https://github.com/atom/atom/ + cd atom + script\build + ``` From 919ca82ccdd573e5934c4c60a111b43a102cc274 Mon Sep 17 00:00:00 2001 From: Corey Johnson Date: Thu, 8 May 2014 16:16:31 -0700 Subject: [PATCH 2/5] Update building section of docs --- README.md | 46 +--------------------------------------------- 1 file changed, 1 insertion(+), 45 deletions(-) diff --git a/README.md b/README.md index 764bb526698..1d3370db29a 100644 --- a/README.md +++ b/README.md @@ -18,51 +18,7 @@ Atom will automatically update when a new release is available. ## Building - -### OS X Requirements - * OS X 10.8 or later - * [node.js](http://nodejs.org/download/) v0.10.x - * Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install) - - ```sh - git clone https://github.com/atom/atom - cd atom - script/build # Creates application at /Applications/Atom.app - ``` - -### Linux Requirements - * Ubuntu LTS 12.04 64-bit is the recommended platform - * OS with 64-bit architecture - * [node.js](http://nodejs.org/download/) v0.10.x - * [npm](http://www.npmjs.org/) v1.4.x - * `sudo apt-get install libgnome-keyring-dev` - * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2 - - ```sh - git clone https://github.com/atom/atom - cd atom - script/build # Creates application at /tmp/atom-build/Atom - sudo script/grunt install # Installs command to /usr/local/bin/atom - script/grunt mkdeb # Generates a .deb package at /tmp/atom-build - ``` - -### Windows Requirements - * Windows 7 or later - * [Visual C++ 2010 SP1 Express](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#DownloadFamilies_4) - * [node.js - 32bit](http://nodejs.org/download/) v0.10.x - * [Python 2.7.x](http://www.python.org/download/) - * [GitHub for Windows](http://windows.github.com/) - * [Git for Windows](http://git-scm.com/download/win) - * Select the option **Use Git from the Windows Command Prompt** when installing (Git needs to be in your `PATH`) - * Clone [atom/atom](https://github.com/atom/atom/) to `C:\Users\\github\atom\` - * Add `C:\Python27;C:\Program Files\nodejs;C:\Users\\github\atom\node_modules\` - to your PATH - * Open the Windows GitHub shell - - ```bat - cd C:\Users\\github\atom - script\build - ``` +See the [build instructions](docs/advanced/build-instructions) docs. ## Developing Check out the [guides](https://atom.io/docs/latest) and the [API reference](https://atom.io/docs/api). From 3a22b3d4b85e903e98ff0b2d7e387d69ee97626b Mon Sep 17 00:00:00 2001 From: Corey Johnson Date: Thu, 8 May 2014 16:30:44 -0700 Subject: [PATCH 3/5] Move build instructions to separate files --- docs/advanced/build-instructions.md | 64 ----------------------------- docs/build-instructions/linux.md | 25 +++++++++++ docs/build-instructions/os-x.md | 19 +++++++++ docs/build-instructions/windows.md | 26 ++++++++++++ 4 files changed, 70 insertions(+), 64 deletions(-) delete mode 100644 docs/advanced/build-instructions.md create mode 100644 docs/build-instructions/linux.md create mode 100644 docs/build-instructions/os-x.md create mode 100644 docs/build-instructions/windows.md diff --git a/docs/advanced/build-instructions.md b/docs/advanced/build-instructions.md deleted file mode 100644 index c844fb48ce5..00000000000 --- a/docs/advanced/build-instructions.md +++ /dev/null @@ -1,64 +0,0 @@ -* [Linux instructions](#linux) -* [OS X instructions](#os-x) -* [Windows instructions](#windows) - -# Linux - -Ubuntu LTS 12.04 64-bit is the recommended platform. - -#### Requirements - - * OS with 64-bit architecture - * [node.js](http://nodejs.org/download/) v0.10.x - * [npm](http://www.npmjs.org/) v1.4.x - * libgnome-keyring-dev `sudo apt-get install libgnome-keyring-dev` - * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2 - -#### Instructions - - ```sh - git clone https://github.com/atom/atom - cd atom - script/build # Creates application at /tmp/atom-build/Atom - sudo script/grunt install # Installs command to /usr/local/bin/atom - script/grunt mkdeb # Generates a .deb package at /tmp/atom-build - ``` - -# OS X - -#### Requirements - - * OS X 10.8 or later - * [node.js](http://nodejs.org/download/) v0.10.x - * Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install) - -#### Instructions - - ```sh - git clone https://github.com/atom/atom - cd atom - script/build # Creates application at /Applications/Atom.app - ``` - -# Windows - -#### Requirements - - * Windows 7 or later - * [Visual C++ 2010 SP1 Express](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#DownloadFamilies_4) - * [node.js - 32bit](http://nodejs.org/download/) v0.10.x - * [Python 2.7.x](http://www.python.org/download/) - * [GitHub for Windows](http://windows.github.com/) - * [Git for Windows](http://git-scm.com/download/win) - * Select the option **Use Git from the Windows Command Prompt** when installing (Git needs to be in your `PATH`) - * Add `C:\Python27;C:\Program Files\nodejs;C:\Users\\github\atom\node_modules\` - to your PATH - -#### Instructions - - ```bat - cd C:\Users\\github - git clone https://github.com/atom/atom/ - cd atom - script\build - ``` diff --git a/docs/build-instructions/linux.md b/docs/build-instructions/linux.md new file mode 100644 index 00000000000..a3629ad2bd3 --- /dev/null +++ b/docs/build-instructions/linux.md @@ -0,0 +1,25 @@ +# Linux + +## Instructions + +Ubuntu LTS 12.04 64-bit is the recommended platform. + +#### Requirements + + * OS with 64-bit architecture + * [node.js](http://nodejs.org/download/) v0.10.x + * [npm](http://www.npmjs.org/) v1.4.x + * libgnome-keyring-dev `sudo apt-get install libgnome-keyring-dev` + * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2 + +#### Instructions + + ```sh + git clone https://github.com/atom/atom + cd atom + script/build # Creates application at /tmp/atom-build/Atom + sudo script/grunt install # Installs command to /usr/local/bin/atom + script/grunt mkdeb # Generates a .deb package at /tmp/atom-build + ``` + +## Troubleshooting diff --git a/docs/build-instructions/os-x.md b/docs/build-instructions/os-x.md new file mode 100644 index 00000000000..f2fb3b32a48 --- /dev/null +++ b/docs/build-instructions/os-x.md @@ -0,0 +1,19 @@ +# OS X + +## Instructions + +#### Requirements + + * OS X 10.8 or later + * [node.js](http://nodejs.org/download/) v0.10.x + * Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install) + +#### Instructions + + ```sh + git clone https://github.com/atom/atom + cd atom + script/build # Creates application at /Applications/Atom.app + ``` + +## Troubleshooting diff --git a/docs/build-instructions/windows.md b/docs/build-instructions/windows.md new file mode 100644 index 00000000000..232cf4bf8c8 --- /dev/null +++ b/docs/build-instructions/windows.md @@ -0,0 +1,26 @@ +# Windows + +## Instructions + +#### Requirements + + * Windows 7 or later + * [Visual C++ 2010 SP1 Express](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#DownloadFamilies_4) + * [node.js - 32bit](http://nodejs.org/download/) v0.10.x + * [Python 2.7.x](http://www.python.org/download/) + * [GitHub for Windows](http://windows.github.com/) + * [Git for Windows](http://git-scm.com/download/win) + * Select the option **Use Git from the Windows Command Prompt** when installing (Git needs to be in your `PATH`) + * Add `C:\Python27;C:\Program Files\nodejs;C:\Users\\github\atom\node_modules\` + to your PATH + +#### Instructions + + ```bat + cd C:\Users\\github + git clone https://github.com/atom/atom/ + cd atom + script\build + ``` + +## Troubleshooting From 8f7123ae12a077d9f930881bb1c744deda0398c8 Mon Sep 17 00:00:00 2001 From: Corey Johnson Date: Thu, 8 May 2014 16:31:10 -0700 Subject: [PATCH 4/5] Update build instruction links --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d3370db29a..7d1ae85f6de 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ Atom will automatically update when a new release is available. ## Building -See the [build instructions](docs/advanced/build-instructions) docs. +* [Linux](docs/build-instructions/linux.md) +* [OS X](docs/build-instructions/os-x.md) +* [Windows](docs/build-instructions/windows.md) ## Developing Check out the [guides](https://atom.io/docs/latest) and the [API reference](https://atom.io/docs/api). From 91342db0bac9daa2475595520d6c5e44ad39ce7c Mon Sep 17 00:00:00 2001 From: Corey Johnson Date: Thu, 8 May 2014 16:34:54 -0700 Subject: [PATCH 5/5] Tweak build instruction content --- docs/build-instructions/linux.md | 6 ++---- docs/build-instructions/os-x.md | 6 ++---- docs/build-instructions/windows.md | 6 ++---- 3 files changed, 6 insertions(+), 12 deletions(-) diff --git a/docs/build-instructions/linux.md b/docs/build-instructions/linux.md index a3629ad2bd3..fd68ab6caba 100644 --- a/docs/build-instructions/linux.md +++ b/docs/build-instructions/linux.md @@ -1,10 +1,8 @@ # Linux -## Instructions - Ubuntu LTS 12.04 64-bit is the recommended platform. -#### Requirements +## Requirements * OS with 64-bit architecture * [node.js](http://nodejs.org/download/) v0.10.x @@ -12,7 +10,7 @@ Ubuntu LTS 12.04 64-bit is the recommended platform. * libgnome-keyring-dev `sudo apt-get install libgnome-keyring-dev` * `npm config set python /usr/bin/python2 -g` to ensure that gyp uses Python 2 -#### Instructions +## Instructions ```sh git clone https://github.com/atom/atom diff --git a/docs/build-instructions/os-x.md b/docs/build-instructions/os-x.md index f2fb3b32a48..26a32ca68aa 100644 --- a/docs/build-instructions/os-x.md +++ b/docs/build-instructions/os-x.md @@ -1,14 +1,12 @@ # OS X -## Instructions - -#### Requirements +## Requirements * OS X 10.8 or later * [node.js](http://nodejs.org/download/) v0.10.x * Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (run `xcode-select --install` to install) -#### Instructions +## Instructions ```sh git clone https://github.com/atom/atom diff --git a/docs/build-instructions/windows.md b/docs/build-instructions/windows.md index 232cf4bf8c8..ab4c293368c 100644 --- a/docs/build-instructions/windows.md +++ b/docs/build-instructions/windows.md @@ -1,8 +1,6 @@ # Windows -## Instructions - -#### Requirements +## Requirements * Windows 7 or later * [Visual C++ 2010 SP1 Express](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#DownloadFamilies_4) @@ -14,7 +12,7 @@ * Add `C:\Python27;C:\Program Files\nodejs;C:\Users\\github\atom\node_modules\` to your PATH -#### Instructions +## Instructions ```bat cd C:\Users\\github