Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Update build requirements #1924

Merged
merged 12 commits into from
May 6, 2014
47 changes: 40 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -19,11 +18,45 @@ Atom will automatically update when a new release is available.

## Building
Copy link
Author

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


```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/)
Copy link
Author

Choose a reason for hiding this comment

The 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).