melodylu / atom

The hackable editor

Atom is a hackable text editor for the 21st century.

Atom is open source and built on top of atom-shell.

Atom is designed to be customizable, but also usable without needing to edit a config file.

Atom is modern, approachable, and hackable to the core.

Visit atom.io to learn more.

Installing

Download the latest Atom release.

Atom will automatically update when a new release is available.

Building

OS X Requirements

• OS X 10.8 or later
• node.js
• Command Line Tools for Xcode (Run xcode-select --install)

git clone https://github.com/atom/atom
cd atom
script/build # Creates application at /Applications/Atom.app

Linux Requirements

• Ubuntu LTS 12.04 64-bit is the recommended platform
• node.js
• sudo apt-get install libgnome-keyring-dev
• npm config set python /usr/bin/python2 -g to ensure that gyp uses Python 2

git clone https://github.com/atom/atom
cd atom
script/build # Creates application at /tmp/atom-build/Atom
sudo script/grunt install # Installs command to /usr/local/bin/atom

Windows Requirements

• Windows 7 or later
• Visual C++ 2010 Express
• node.js - 32bit
• Python 2.7.x
• GitHub for Windows
• Git for Windows
  • Select the option Use Git from the Windows Command Prompt when installing (Git needs to be in your PATH)
• Clone atom/atom to C:\Users\<user>\github\atom\
• Add C:\Python27;C:\Program Files\nodejs;C:\Users\<user>\github\atom\node_modules\ to your PATH
• Open the Windows GitHub shell

cd C:\Users\<user>\github\atom
script/build

Developing

Check out the guides and the API reference.