A Community-led Hyper-Hackable Text Editor
Go to file
2012-09-13 11:25:37 -07:00
.atom Carry CEF1 directories over to CEF3 2012-08-31 10:43:21 -07:00
Atom-Linux Carry CEF1 directories over to CEF3 2012-08-31 10:43:21 -07:00
benchmark WIP: Getting specs and benchmarks running from the command line 2012-08-30 18:10:05 -06:00
bundles Add bundles and themes 2012-08-27 13:20:22 -07:00
cef Rename ClientHandler to AtomCefClient 2012-08-25 11:17:47 -06:00
docs Carry CEF1 directories over to CEF3 2012-08-31 10:43:21 -07:00
native Remove rogue log 2012-09-10 17:22:21 -07:00
script Carry CEF1 directories over to CEF3 2012-08-31 10:43:21 -07:00
spec Add support for back-references in TextMate grammars 2012-09-07 15:27:13 -07:00
src Handle begin/end patterns with no name or contentName 2012-09-07 18:54:54 -07:00
static WIP: Getting specs and benchmarks running from the command line 2012-08-30 18:10:05 -06:00
themes Add bundles and themes 2012-08-27 13:20:22 -07:00
tools Move scripts in cef/mac to tools/mac since we have tools dir anyway for gyp 2012-08-10 16:11:09 -06:00
vendor Add atom.exit, which exits from the browser process instead of the renderer 2012-08-31 10:15:12 -06:00
.gitignore Stub a package.json 2012-09-13 11:25:37 -07:00
.pairs Add pairs file 2012-08-24 17:05:46 -06:00
atom.gyp Remove util.h 2012-08-30 09:07:39 -07:00
package.json Stub a package.json 2012-09-13 11:25:37 -07:00
Rakefile WIP: Getting specs and benchmarks running from the command line 2012-08-30 18:10:05 -06:00
README.md Carry CEF1 directories over to CEF3 2012-08-31 10:43:21 -07:00

Atom — Futuristic Text Editing

Be forwarned: Atom is pre-alpha software!

Building from source

  1. Get xcode 4.2 or above

  2. Install CoffeeScript http://coffeescript.org/

brew install nodejs
curl https://npmjs.org/install.sh | sh
npm i -g coffee-script
  1. git clone git@github.com:github/atom.git

  2. cd atom

  3. 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 explore features.

cmd-o : open file/directory

cmd-n : new window

cmd-t : open fuzzy file finder

cmd-: : open command prompt

cmd-f : open command prompt with /

cmd-g : repeat the last search

cmd-r : reload the current window

cmd-alt-ctrl-s : run specs

cmd-alt-arrows : split screen in direction of arrow

cmd-alt-w : toggle word wrap

cmd-alt-f : fold selected lines

Most default OS X keybindings also work.

Init Script

Atom will require ~/.atom/atom.coffee whenever a window is opened or reloaded if it is present in your home directory. This is a rudimentary jumping off point for your own customizations.

Command Panel

A partial implementation of the Sam command language

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

Key Bindings

Atom has a CSS based key binding scheme. We will add a nicer loading mechanism, but for now you can bind keys by calling window.keymap.bindKeys with a CSS selector and a hash of key-pattern -> event mappings.

window.keymap.bindKeys '.editor'
  'ctrl-p': 'party-time'
  'ctrl-q': 'open-dialog-q'

When a keypress matches a pattern on an element that matches the selector, it will be translated to the named event, which will bubble up the DOM from the site of the keypress. Extension code can listen for the named event and react to it.