mirror of
https://github.com/atom/atom.git
synced 2026-01-23 05:48:10 -05:00
updated readme
This commit is contained in:
49
README.md
49
README.md
@@ -3,21 +3,50 @@
|
||||
|
||||
## Be forwarned: Atom is pre-alpha software!
|
||||
|
||||
## Installation
|
||||
## Download
|
||||
|
||||
1. Get [xcode 4.2](http://itunes.apple.com/us/app/xcode/id448457090?mt=12).
|
||||
1. Download [atom.zip](https://github.com/downloads/github/atom/atom.zip)
|
||||
|
||||
2. Clone atom from github/atom.
|
||||
2. Unzip and open the app
|
||||
|
||||
3. Open Atom.xcodeproject.
|
||||
## Basic Keyboard shortcuts
|
||||
|
||||
4. Press cmd-r to build and run.
|
||||
`cmd-o` : open file/directory
|
||||
`cmd-n` : new window
|
||||
`cmd-alt-ctrl-s` : run specs
|
||||
`cmd-t` : open fuzzy finder
|
||||
`cmd-:` : open command prompt
|
||||
`cmd-f` : open command prompt with /
|
||||
`cmd-g` : repeat the last search
|
||||
`cmd-alt-w` : toggle word wrap
|
||||
`cmd-alt-f` : fold selected lines
|
||||
|
||||
## Informative Links
|
||||
Most default OS X keybindings also work.
|
||||
|
||||
* [Ace](https://github.com/ajaxorg/ace)
|
||||
## Command Panel
|
||||
|
||||
* [commonjs](http://wiki.commonjs.org)
|
||||
A partial implementation of the [Sam command language](http://man.cat-v.org/plan_9/1/sam)
|
||||
|
||||
* [JSCocoa](https://github.com/parmanoir/jscocoa/)
|
||||
fin
|
||||
*Examples*
|
||||
`,` selects entire file
|
||||
`1,4` selects lines 1-4
|
||||
`/pattern` selects the first match after the cursor/selection
|
||||
`s/pattern/replacement` replace first text matching pattern in current selection
|
||||
`s/pattern/replacement/g` replace all text matching pattern in current selection
|
||||
`,s/pattern/replacement/g` replace all text matching pattern in file
|
||||
`1,4s/pattern/replacement` replace all text matching pattern in lines 1-4
|
||||
`x/pattern` selects all matches in the current selections
|
||||
`,x/pattern` selects all matches in the file
|
||||
`,x/pattern1/ x/pattern2` "structural regex" - selects all matches of pattern2 inside matches of pattern1
|
||||
|
||||
## 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`
|
||||
Reference in New Issue
Block a user