pulsar/README.md

82 lines
4.6 KiB
Markdown
Raw Normal View History

2014-05-05 02:42:45 +04:00
![Atom](https://cloud.githubusercontent.com/assets/72919/2874231/3af1db48-d3dd-11e3-98dc-6066f8bc766f.png)
2012-08-31 21:43:21 +04:00
[![Build status](https://dev.azure.com/github/Atom/_apis/build/status/Atom%20Production%20Branches?branchName=master)](https://dev.azure.com/github/Atom/_build/latest?definitionId=32&branchName=master) [![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](https://atom-slack.herokuapp.com/badge.svg)](https://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
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.
2015-07-08 21:44:04 +03:00
## Documentation
If you want to read about using Atom or developing packages in Atom, the [Atom Flight Manual](https://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.
2013-06-10 20:00:08 +04:00
## Installing
### Prerequisites
- [Git](https://git-scm.com)
2016-06-18 16:33:08 +03:00
### macOS
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
### Windows
Download the latest [Atom installer](https://github.com/atom/atom/releases/latest). `AtomSetup.exe` is 32-bit. For 64-bit systems, download `AtomSetup-x64.exe`.
2014-12-10 03:34:16 +03:00
Atom will automatically update when a new release is available.
2016-10-22 02:47:25 +03:00
You can also download `atom-windows.zip` (32-bit) or `atom-x64-windows.zip` (64-bit) from the [releases page](https://github.com/atom/atom/releases/latest).
2014-12-10 03:34:16 +03:00
The `.zip` version will not automatically update.
Using [Chocolatey](https://chocolatey.org)? Run `cinst Atom` to install the latest version of Atom.
2014-12-10 03:37:54 +03:00
### Linux
2014-09-19 20:36:05 +04:00
Atom is only available for 64-bit Linux systems.
2014-09-19 20:36:05 +04:00
Configure your distribution's package manager to install and update Atom by following the [Linux installation instructions](https://flight-manual.atom.io/getting-started/sections/installing-atom/#platform-linux) in the Flight Manual. You will also find instructions on how to install Atom's official Linux packages without using a package repository, though you will not get automatic updates after installing Atom this way.
### 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
2017-11-13 15:17:41 +03:00
* [Linux](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/#platform-linux)
* [macOS](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/#platform-mac)
* [Windows](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/#platform-windows)
2018-02-26 18:13:42 +03:00
## Discussion
* Discuss Atom on our [forums](https://discuss.atom.io/)
* Chat about Atom on our Slack team -- [instructions for joining](https://discuss.atom.io/t/join-us-on-slack/16638?source_topic_id=25406)
2018-02-26 15:28:07 +03:00
## License
[MIT](https://github.com/atom/atom/blob/master/LICENSE.md)
2016-11-08 01:37:40 +03:00
When using the Atom or other GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).