2014-05-05 02:42:45 +04:00
2012-08-31 21:43:21 +04:00
2016-07-27 11:29:37 +03:00
[](https://circleci.com/gh/atom/atom) [](https://travis-ci.org/atom/atom) [](https://ci.appveyor.com/project/Atom/atom)
2015-04-22 00:11:24 +03:00
[](https://david-dm.org/atom/atom)
2015-06-11 22:40:24 +03:00
[](http://atom-slack.herokuapp.com/)
2015-04-16 19:55:23 +03:00
2015-04-17 22:37:22 +03:00
Atom is a hackable text editor for the 21st century, built on [Electron ](https://github.com/atom/electron ), and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration.
2014-05-06 00:04:22 +04:00
2014-12-07 05:30:18 +03:00
Visit [atom.io ](https://atom.io ) to learn more or visit the [Atom forum ](https://discuss.atom.io ).
2012-08-31 21:43:21 +04:00
2015-04-24 03:03:37 +03:00
Follow [@AtomEditor ](https://twitter.com/atomeditor ) on Twitter for important
announcements.
2015-04-24 02:59:02 +03:00
2015-12-03 19:08:03 +03:00
This project adheres to the Contributor Covenant [code of conduct ](CODE_OF_CONDUCT.md ).
2015-08-10 19:19:26 +03:00
By participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com.
2015-07-08 21:44:04 +03:00
2015-03-12 01:00:33 +03:00
## Documentation
2016-05-24 01:01:16 +03:00
If you want to read about using Atom or developing packages in Atom, the [Atom Flight Manual ](http://flight-manual.atom.io ) is free and available online. You can find the source to the manual in [atom/flight-manual.atom.io ](https://github.com/atom/flight-manual.atom.io ).
2015-03-12 01:00:33 +03:00
The [API reference ](https://atom.io/docs/api ) for developing packages is also documented on Atom.io.
2013-06-10 20:00:08 +04:00
## Installing
2016-01-26 22:38:24 +03:00
### Prerequisites
- [Git ](https://git-scm.com/ )
2016-06-18 16:33:08 +03:00
### macOS
2014-07-09 22:14:21 +04:00
2013-11-27 22:59:11 +04:00
Download the latest [Atom release ](https://github.com/atom/atom/releases/latest ).
2013-06-10 20:00:08 +04:00
2013-11-27 22:59:11 +04:00
Atom will automatically update when a new release is available.
2013-06-10 20:00:08 +04:00
2014-07-09 22:14:21 +04:00
### Windows
2014-12-10 03:34:16 +03:00
Download the latest [AtomSetup.exe installer ](https://github.com/atom/atom/releases/latest ).
2014-07-09 22:14:21 +04:00
2014-12-10 03:34:16 +03:00
Atom will automatically update when a new release is available.
You can also download an `atom-windows.zip` file from the [releases page ](https://github.com/atom/atom/releases/latest ).
The `.zip` version will not automatically update.
2014-07-14 04:56:50 +04:00
2015-02-04 22:37:17 +03:00
Using [chocolatey ](https://chocolatey.org/ )? Run `cinst Atom` to install
the latest version of Atom.
2014-12-10 03:37:54 +03:00
2014-09-19 20:36:05 +04:00
### Debian Linux (Ubuntu)
Currently only a 64-bit version is available.
1. Download `atom-amd64.deb` from the [Atom releases page ](https://github.com/atom/atom/releases/latest ).
2. Run `sudo dpkg --install atom-amd64.deb` on the downloaded package.
3. Launch Atom using the installed `atom` command.
The Linux version does not currently automatically update so you will need to
repeat these steps to upgrade to future releases.
2015-06-22 18:42:21 +03:00
### Red Hat Linux (Fedora 21 and under, CentOS, Red Hat)
2014-10-28 02:08:21 +03:00
Currently only a 64-bit version is available.
1. Download `atom.x86_64.rpm` from the [Atom releases page ](https://github.com/atom/atom/releases/latest ).
2. Run `sudo yum localinstall atom.x86_64.rpm` on the downloaded package.
3. Launch Atom using the installed `atom` command.
The Linux version does not currently automatically update so you will need to
repeat these steps to upgrade to future releases.
2015-06-22 18:42:21 +03:00
### Fedora 22+
Currently only a 64-bit version is available.
1. Download `atom.x86_64.rpm` from the [Atom releases page ](https://github.com/atom/atom/releases/latest ).
2015-10-23 03:31:01 +03:00
2. Run `sudo dnf install ./atom.x86_64.rpm` on the downloaded package.
2015-06-22 18:42:21 +03:00
3. Launch Atom using the installed `atom` command.
The Linux version does not currently automatically update so you will need to
repeat these steps to upgrade to future releases.
2015-11-12 18:15:19 +03:00
### Archive extraction
An archive is available for people who don't want to install `atom` as root.
This version enables you to install multiple Atom versions in parallel. It has been built on Ubuntu 64-bit,
but should be compatible with other Linux distributions.
1. Install dependencies (on Ubuntu): `sudo apt install git gconf2 gconf-service libgtk2.0-0 libudev1 libgcrypt20
libnotify4 libxtst6 libnss3 python gvfs-bin xdg-utils libcap2`
2. Download `atom-amd64.tar.gz` from the [Atom releases page ](https://github.com/atom/atom/releases/latest ).
3. Run `tar xf atom-amd64.tar.gz` in the directory where you want to extract the Atom folder.
4. Launch Atom using the installed `atom` command from the newly extracted directory.
The Linux version does not currently automatically update so you will need to
repeat these steps to upgrade to future releases.
2013-06-10 20:00:08 +04:00
## Building
2012-09-25 20:24:50 +04:00
2014-05-09 03:31:10 +04:00
* [Linux ](docs/build-instructions/linux.md )
2016-06-18 17:41:35 +03:00
* [macOS ](docs/build-instructions/macos.md )
2014-05-09 11:28:50 +04:00
* [FreeBSD ](docs/build-instructions/freebsd.md )
2014-05-09 03:31:10 +04:00
* [Windows ](docs/build-instructions/windows.md )
