From 98e8a4f142073a8871b542672073e34af7f5a770 Mon Sep 17 00:00:00 2001 From: The Gitter Badger Date: Sun, 4 Dec 2016 07:07:31 +0000 Subject: [PATCH] Add Gitter badge --- README.md | 85 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 62 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 017c5cb08e0..b6d07b7569c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,33 @@ ![Atom](https://cloud.githubusercontent.com/assets/72919/2874231/3af1db48-d3dd-11e3-98dc-6066f8bc766f.png) -Atom is a hackable text editor for the 21st century, built on [atom-shell](http://github.com/atom/atom-shell), and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration. +[![macOS Build Status](https://circleci.com/gh/atom/atom.svg?style=svg)](https://circleci.com/gh/atom/atom) [![Linux Build Status](https://travis-ci.org/atom/atom.svg?branch=master)](https://travis-ci.org/atom/atom) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/1tkktwh654w07eim?svg=true)](https://ci.appveyor.com/project/Atom/atom) +[![Dependency Status](https://david-dm.org/atom/atom.svg)](https://david-dm.org/atom/atom) +[![Join the Atom Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/) -Visit [atom.io](https://atom.io) to learn more. +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. -Visit [issue #3684](https://github.com/atom/atom/issues/3684) to learn more -about the Atom 1.0 roadmap. +Visit [atom.io](https://atom.io) to learn more or visit the [Atom forum](https://discuss.atom.io). + +Follow [@AtomEditor](https://twitter.com/atomeditor) on Twitter for important +announcements. + +This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). +By participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com. + +## Documentation + +[![Join the chat at https://gitter.im/substance-ide/Lobby](https://badges.gitter.im/substance-ide/Lobby.svg)](https://gitter.im/substance-ide/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +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). + +The [API reference](https://atom.io/docs/api) for developing packages is also documented on Atom.io. ## Installing -### Mac OS X +### Prerequisites +- [Git](https://git-scm.com/) + +### macOS Download the latest [Atom release](https://github.com/atom/atom/releases/latest). @@ -17,20 +35,19 @@ Atom will automatically update when a new release is available. ### Windows -Install the [Atom chocolatey package](https://chocolatey.org/packages/Atom). +Download the latest [AtomSetup.exe installer](https://github.com/atom/atom/releases/latest). + +Atom will automatically update when a new release is available. -1. Install [chocolatey](https://chocolatey.org). -2. Close and reopen your command prompt or PowerShell window. -3. Run `cinst Atom` -4. In the future run `cup Atom` to upgrade to the latest release. +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. -You can also download a `.zip` file from the [releases page](https://github.com/atom/atom/releases/latest). -The Windows version does not currently automatically update so you will need to -manually upgrade to future releases by re-downloading the `.zip` file. +Using [chocolatey](https://chocolatey.org/)? Run `cinst Atom` to install +the latest version of Atom. ### Debian Linux (Ubuntu) -Currently only a 64-bit version is available. +Atom is only available for 64-bit Linux systems. 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. @@ -39,9 +56,9 @@ Currently only a 64-bit version is available. The Linux version does not currently automatically update so you will need to repeat these steps to upgrade to future releases. -### Red Hat Linux (Fedora, CentOS, Red Hat) +### Red Hat Linux (Fedora 21 and under, CentOS, Red Hat) -Currently only a 64-bit version is available. +Atom is only available for 64-bit Linux systems. 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. @@ -50,13 +67,35 @@ Currently only a 64-bit version is available. The Linux version does not currently automatically update so you will need to repeat these steps to upgrade to future releases. -## Building +### Fedora 22+ + +Atom is only available for 64-bit Linux systems. + +1. Download `atom.x86_64.rpm` from the [Atom releases page](https://github.com/atom/atom/releases/latest). +2. Run `sudo dnf install ./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. + +### Archive extraction -* [Linux](docs/build-instructions/linux.md) -* [OS X](docs/build-instructions/os-x.md) -* [FreeBSD](docs/build-instructions/freebsd.md) -* [Windows](docs/build-instructions/windows.md) +An archive is available for people who don't want to install `atom` as root. -## Developing +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. + +## Building -Check out the [guides](https://atom.io/docs/latest) and the [API reference](https://atom.io/docs/api). +* [Linux](./docs/build-instructions/linux.md) +* [macOS](./docs/build-instructions/macos.md) +* [FreeBSD](./docs/build-instructions/freebsd.md) +* [Windows](./docs/build-instructions/windows.md)