First cut at build documentation

This commit is contained in:
Matt Colyer 2013-10-31 11:29:43 -07:00
parent 34499d87ab
commit a57f1e4727

33
docs/building-atom.md Normal file
View File

@ -0,0 +1,33 @@
## Building Atom
These guide is meant only for users who wish to help develop atom core,
if you're just intersted in using atom you should just [download
atom][download].
## OSX
* Use Mountain Lion
* Install the latest node 0.10.x release (32bit preferable)
* Clone [atom][atom-git] to `~/github/atom`
* Run `~/github/atom/script/bootstrap`
## Windows
* Install [Visual C++ 2010 Express][win-vs2010]
* Install the [latest 32bit Node 0.10.x][win-node]
* Install the [latest Python 2.7.x][win-python]
* Install [Github for Windows][win-github]
* Clone [atom/atom][atom-git] to `C:\Users\<user>\Documents\GitHub\atom\`
* Add `C:\Python27;C:\Program Files\nodejs;C:\Users\<user>\Documents\GitHub\atom\node_modules\`
to your PATH
* Set ATOM_ACCESS_TOKEN to your oauth2 credentials (run `security -q
find-generic-password -ws 'GitHub API Token'` on OSX to get your
credentials).
* Use the Windows GitHub shell and cd into `C:\Users\<user>\Documents\GitHub\atom`
* Run `node script/bootstrap`
[download]: http://www.atom.io
[win-node]: http://nodejs.org/download/
[win-python]: http://www.python.org/download/
[win-github]: http://windows.github.com/
[atom-git]: https://github.com/atom/atom/