From 9fe507d675ac80decbe714c4fc62ce7d2380ba2f Mon Sep 17 00:00:00 2001 From: probablycorey Date: Wed, 27 Nov 2013 10:59:11 -0800 Subject: [PATCH] Update readme and build instructions --- README.md | 25 ++++++------------------- docs/building-atom.md | 7 ++++--- 2 files changed, 10 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e35858487..7562b6015 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,17 @@ -# Atom — Futuristic Text Editing +# Atom — The hackable, ~~collaborative~~ editor of tomorrow! -![atom](https://s3.amazonaws.com/speakeasy/apps/icons/27/medium/7db16e44-ba57-11e2-8c6f-981faf658e00.png) +![Atom](https://www.atom.io/assets/logo-e793a022e41eff6879fd6205bc06ef92.png) -Check out our [guides](https://www.atom.io/docs/latest/) and [API documentation](https://www.atom.io/docs/api/v34.0.0/api/) +Check out our [guides and API documentation](https://www.atom.io/docs/latest/) ## Installing -Download the latest Atom release from [speakeasy](https://speakeasy.githubapp.com/apps/27). +Download the latest [Atom release](https://github.com/atom/atom/releases/latest). -It will automatically update when a new release is available. +Atom will automatically update when a new release is available. ## Building -### Requirements - - * Mountain Lion - * Looking for Windows support? Read [here][building]. - * Boxen (Obviously Atom won't release with this requirement) - -### Installation - - 1. `gh-setup atom` - - 2. `cd ~/github/atom` - - 3. `script/build` - + Follow the instructions in the [build docs][building] [building]: https://github.com/atom/atom/blob/master/docs/building-atom.md diff --git a/docs/building-atom.md b/docs/building-atom.md index b2ea2414a..4b96be9a0 100644 --- a/docs/building-atom.md +++ b/docs/building-atom.md @@ -6,10 +6,11 @@ atom][download]. ## OSX -* Use Mountain Lion +* Use OS X 10.8 or later * Install the latest node 0.10.x release (32bit preferable) +* Install cmake * Clone [atom][atom-git] to `~/github/atom` -* Run `~/github/atom/script/bootstrap` +* Run `~/github/atom/script/build` ## Windows @@ -26,7 +27,7 @@ atom][download]. * Use the Windows GitHub shell and cd into `C:\Users\\github\atom` * Run `script\bootstrap` -[download]: http://www.atom.io +[download]: https://github.com/atom/atom/releases/latest [win-node]: http://nodejs.org/download/ [win-python]: http://www.python.org/download/ [win-github]: http://windows.github.com/