github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-23 05:48:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Nathan Sobo
2012-07-06 13:41:10 -06:00
parent 569359b687
commit 60eb4a8a55
1 changed files with 19 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,11 +1,27 @@
# Atom — Futuristic Text Editing
## Be forwarned: Atom is pre-alpha software!
## Download
1. Download from [speakeasy](https://speakeasy.githubapp.com/apps/com.github.atom-osx)
## Building from source
2. Unzip and open the app
1. Get [xcode 4.2 or above](http://itunes.apple.com/us/app/xcode/id448457090?mt=12)
2. Install CoffeeScript http://coffeescript.org/
```
brew install nodejs
curl http://npmjs.org/install.sh | sh
npm i -g coffee-script
```
3. `git clone git@github.com:github/atom.git`
4. `cd atom`
5. `rake run`
## Setup Your ~/.atom Directory
An example .atom directory can be found at the root of the source tree
## Basic Keyboard shortcuts
Atom doesn't have much in the way of menus yet. Use these keyboard shortcuts to
@@ -82,14 +98,3 @@ named event, which will bubble up the DOM from the site of the keypress. Extensi
the named event and react to it.
## Build from source
1. Get [xcode 4.2](http://itunes.apple.com/us/app/xcode/id448457090?mt=12)
2. Install CoffeeScript http://coffeescript.org/ (try `npm i -g coffee-script`)
3. `git clone git@github.com:github/atom.git`
4. `cd atom`
5. `rake run`