This repository has been archived by the owner on Mar 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 17.4k
Update build requirements #1924
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
546f81f
Fix spacing
eb31c6c
Add OS X build requirements
bb2527b
Add stub linux and windows requirements
f5df111
Add Linux platform note and keyring install command
kevinsawicki 8f3b76d
Update Windows requirements
5a53b34
Add more specific node details
084e4ab
Use previous windows readme directions
cf6d83a
Update windows version requirement
31b06b2
Update script/build directions
fe4016a
:penguin: Mention separate build/install
kevinsawicki 15c2540
Merge branch 'master' into cj-readme-requirements
kevinsawicki 3a03f47
Use .bat fence instead of .sh
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,8 +8,7 @@ Atom is designed to be customizable, but also usable without needing to edit a c | |
|
||
Atom is modern, approachable, and hackable to the core. | ||
|
||
Visit [atom.io](http://atom.io) | ||
to learn more. | ||
Visit [atom.io](http://atom.io) to learn more. | ||
|
||
## Installing | ||
|
||
|
@@ -19,11 +18,45 @@ Atom will automatically update when a new release is available. | |
|
||
## Building | ||
|
||
```sh | ||
git clone git@github.com:atom/atom.git | ||
cd atom | ||
script/build # Creates application at /Applications/Atom.app | ||
``` | ||
|
||
**OS X Requirements** | ||
* OS X 10.8 or later | ||
* [node.js](http://nodejs.org/) | ||
* Command Line Tools for [Xcode](https://developer.apple.com/xcode/downloads/) (Run `xcode-select --install`) | ||
|
||
```sh | ||
git clone git@github.com:atom/atom.git | ||
cd atom | ||
script/build # Creates application at /Applications/Atom.app | ||
``` | ||
|
||
**Linux Requirements** | ||
* Ubuntu LTS 12.04 64-bit is the recommended platform | ||
* [node.js](http://nodejs.org/) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @kevinsawicki @zcbenz @thedaniel I'm not sure what else is needed here. @thedaniel mentioned the gnome-keychain headers are also a requirement. |
||
* `sudo apt-get install libgnome-keyring-dev` | ||
|
||
```sh | ||
git clone git@github.com:atom/atom.git | ||
cd atom | ||
script/build # Creates application at /tmp/atom-build/Atom | ||
sudo script/grunt install # Installs command to /usr/local/bin/atom | ||
``` | ||
|
||
**Windows Requirements** | ||
* Windows 7 or later | ||
* [Visual C++ 2010 Express][http://www.microsoft.com/visualstudio/eng/products/visual-studio-2010-express] | ||
* [node.js - 32bit][http://nodejs.org/] | ||
* [Python 2.7.x][ http://www.python.org/download/] | ||
* [GitHub for Windows][http://windows.github.com/] | ||
* Clone [atom/atom][https://github.com/atom/atom/] to `C:\Users\<user>\github\atom\` | ||
* Add `C:\Python27;C:\Program Files\nodejs;C:\Users\<user>\github\atom\node_modules\` | ||
to your PATH | ||
* Open the Windows GitHub shell | ||
|
||
```bat | ||
cd C:\Users\<user>\github\atom | ||
script/build | ||
``` | ||
|
||
## Developing | ||
Check out the [guides](https://atom.io/docs/latest) and the [API reference](atom.io/docs/api). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The build steps got pretty big. We can probably move each platforms build instructions into a separate doc