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

Update the readme

Browse Source
This commit is contained in:
probablycorey
2014-04-28 14:42:31 -07:00
parent 0a8f2422d3
commit 3d2dedb49f
1 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -1,8 +1,12 @@
# Atom — The hackable editor
# Atom — A hackable text editor for the 21st Century
![Atom](http://i.imgur.com/OrTvUAD.png)
Check out our [guides and API documentation](https://atom.io/docs/latest).
Atom is an open source text editor built on top of
[atom-shell](http://github.com/atom/atom-shell). It's 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](http://atom.io)
to learn more.
## Installing
@@ -12,6 +16,11 @@ Atom will automatically update when a new release is available.
## Building
Follow the instructions in the [build docs][building].
```
git clone git@github.com:atom/atom.git
cd atom
script/build # Creates application at /Applications/Atom.app
```
[building]: https://github.com/atom/atom/blob/master/docs/building-atom.md
## Developing
Check out the [guides](https://atom.io/docs/latest) and the [API reference](atom.io/docs/api).