A Community-led Hyper-Hackable Text Editor
Go to file
2013-01-29 18:21:38 -08:00
.atom moving themes to vendor/themes 2013-01-22 12:39:40 -08:00
benchmark Load grammars from TextMatePackage. Delete TextMateBundle. 2012-12-31 18:28:38 -06:00
cef Upgrade CEF to branch 1364, revision 1065 to fix a bug in v8 2013-01-28 14:58:21 -07:00
docs Updating docs with info about theme structure 2013-01-22 16:53:54 -08:00
git2 Use Release build of libgit2 at 11fccddcb5 2013-01-28 09:38:43 -08:00
native Inject all native extensions into web worker contexts 2013-01-24 17:22:50 -08:00
notes Move old wiki page to notes folder 2012-09-30 15:00:45 -07:00
script Merge branch 'web-workers' into dev 2013-01-28 15:02:57 -07:00
spec Don't move trailing newline for multiline selections 2013-01-29 16:51:33 -08:00
src Call delete() from deleteRows() 2013-01-29 17:16:33 -08:00
static these need to be here for now 2013-01-23 16:05:55 -08:00
themes style key binding to match atom dark 2013-01-29 11:05:35 -08:00
tools/mac no more custom gyp 2012-10-18 16:00:14 -07:00
vendor Add python bundle as submodule 2013-01-29 18:21:38 -08:00
.github Add installing package doc file 2013-01-09 10:33:57 -08:00
.gitignore Remove/ignore tags file and add rake task to generate 2012-12-14 09:14:22 -08:00
.gitmodules Add python bundle as submodule 2013-01-29 18:21:38 -08:00
.pairs add me to the pairs file 2013-01-17 16:29:24 -08:00
atom.gyp Add Sparkle.framework and DSA key for speakeasy 2013-01-23 15:09:58 -08:00
package.json Precompile cson files to json 2013-01-17 16:50:25 -08:00
Rakefile Specify resource path when running test task 2013-01-28 16:49:41 -08:00
README.md Update Atom banner in README 2013-01-11 16:10:11 -08:00

Atom — Futuristic Text Editing

atom

Building from source

Be forwarned: Atom is pre-alpha software!

Requirements

Mountain Lion

The Setup™

Xcode (Get Xcode from the App Store (ugh, I know))

  1. gh-setup atom

  2. cd ~/github/atom && rake install

Atom is installed! Type atom [path] from the commmand line or find it in /Applications/Atom.app

Your ~/.atom Directory

A basic ~/.atom directory is installed when you run rake install. Take a look at ~/.atom/atom.coffee for more information.

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.