mirror of
https://github.com/pulsar-edit/pulsar.git
synced 2024-08-17 23:20:21 +03:00
Separated Sections & Added Quicklinks
This commit is contained in:
ElectronicsArchiver
parent
948d9187df
commit
246f55107f
102
README.md
102
README.md
@ -19,11 +19,6 @@
|
||||
|
||||
</div>
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
@ -32,9 +27,22 @@
|
||||
|
||||
Atom is a hackable text editor for the 21st century, built on [Electron](https://github.com/electron/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.
|
||||
|
||||
<div align = center>
|
||||
|
||||
![Banner]
|
||||
|
||||
<br>
|
||||
|
||||
[![Button Install]][Install]
|
||||
[![Button Documentation]][Documentation]
|
||||
[![Button Build]][Build]
|
||||
|
||||
<br>
|
||||
|
||||
![Preview]
|
||||
|
||||
</div>
|
||||
|
||||
Visit [atom.io](https://atom.io) to learn more or visit the [Atom forum](https://github.com/atom/atom/discussions).
|
||||
|
||||
Follow [@AtomEditor](https://twitter.com/atomeditor) on Twitter for important
|
||||
@ -43,64 +51,6 @@ 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
|
||||
|
||||
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.
|
||||
|
||||
## Installing
|
||||
<!-- ### Prerequisites
|
||||
- [Git](https://git-scm.com)
|
||||
|
||||
### macOS
|
||||
|
||||
Download the latest [Atom release](https://github.com/atom/atom/releases/latest).
|
||||
|
||||
Atom will automatically update when a new release is available.
|
||||
|
||||
### 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`.
|
||||
|
||||
Atom will automatically update when a new release is available.
|
||||
|
||||
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).
|
||||
The `.zip` version will not automatically update.
|
||||
|
||||
Using [Chocolatey](https://chocolatey.org)? Run `cinst Atom` to install the latest version of Atom.
|
||||
|
||||
### Linux
|
||||
|
||||
Atom is only available for 64-bit Linux systems.
|
||||
|
||||
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):
|
||||
```sh
|
||||
sudo apt install git libasound2 libcurl4 libgbm1 libgcrypt20 libgtk-3-0 libnotify4 libnss3 libglib2.0-bin xdg-utils libx11-xcb1 libxcb-dri3-0 libxss1 libxtst6 libxkbfile1
|
||||
```
|
||||
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. -->
|
||||
Currently, to get binaries based on code by the Atom community, binaries can be downloaded from the [Azure Pipeline](https://dev.azure.com/atomcommunity/atomcommunity/_build/latest?definitionId=10&branchName=master). From this pipeline, the latest run can be selected. From there, the `8 published` link should be selected to download the files.
|
||||
|
||||
## Building
|
||||
|
||||
* [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)
|
||||
|
||||
|
||||
## License
|
||||
|
||||
@ -109,15 +59,31 @@ When using the Atom or other GitHub logos, be sure to follow the [GitHub logo gu
|
||||
|
||||
<!---------------------------------------------------------------->
|
||||
|
||||
[Badge Discord]: https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logoColor=white&logo=Discord
|
||||
[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge
|
||||
[Badge Status]: https://dev.azure.com/atomcommunity/atomcommunity/_apis/build/status/atom-community/Release%20Branch%20Build?branchName=master
|
||||
|
||||
[Official Announcement]: https://github.blog/2022-06-08-sunsetting-atom/
|
||||
[Discord]: https://discord.gg/2tD9evh8qP
|
||||
[License]: LICENSE.md
|
||||
[Status]: https://dev.azure.com/atomcommunity/atomcommunity/_build/latest?definitionId=10&branchName=master
|
||||
|
||||
|
||||
[Banner]: https://user-images.githubusercontent.com/378023/49132477-f4b77680-f31f-11e8-8357-ac6491761c6c.png
|
||||
[Preview]: https://user-images.githubusercontent.com/378023/49132478-f4b77680-f31f-11e8-9e10-e8454d8d9b7e.png
|
||||
|
||||
|
||||
[Documentation]: docs/Documentation.md
|
||||
[Install]: docs/Installation.md
|
||||
[License]: LICENSE.md
|
||||
[Build]: docs/Building.md
|
||||
|
||||
|
||||
<!---------------------------{ Badges }--------------------------->
|
||||
|
||||
[Badge Discord]: https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logoColor=white&logo=Discord
|
||||
[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge
|
||||
[Badge Status]: https://dev.azure.com/atomcommunity/atomcommunity/_apis/build/status/atom-community/Release%20Branch%20Build?branchName=master
|
||||
|
||||
|
||||
<!--------------------------{ Buttons }--------------------------->
|
||||
|
||||
[Button Documentation]: https://img.shields.io/badge/Documentation-008FC7?style=for-the-badge&logoColor=white&logo=GitBook
|
||||
[Button Install]: https://img.shields.io/badge/Install-48A842?style=for-the-badge&logoColor=white&logo=DocuSign
|
||||
[Button Build]: https://img.shields.io/badge/Building-C2A633?style=for-the-badge&logoColor=white&logo=GNUBash
|
||||
|
||||
|
||||
6
docs/Building.md
Normal file
6
docs/Building.md
Normal file
@ -0,0 +1,6 @@
|
||||
|
||||
## Building
|
||||
|
||||
* [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)
|
||||
5
docs/Documentation.md
Normal file
5
docs/Documentation.md
Normal file
@ -0,0 +1,5 @@
|
||||
## 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.
|
||||
45
docs/Installation.md
Normal file
45
docs/Installation.md
Normal file
@ -0,0 +1,45 @@
|
||||
## Installing
|
||||
<!-- ### Prerequisites
|
||||
- [Git](https://git-scm.com)
|
||||
|
||||
### macOS
|
||||
|
||||
Download the latest [Atom release](https://github.com/atom/atom/releases/latest).
|
||||
|
||||
Atom will automatically update when a new release is available.
|
||||
|
||||
### 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`.
|
||||
|
||||
Atom will automatically update when a new release is available.
|
||||
|
||||
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).
|
||||
The `.zip` version will not automatically update.
|
||||
|
||||
Using [Chocolatey](https://chocolatey.org)? Run `cinst Atom` to install the latest version of Atom.
|
||||
|
||||
### Linux
|
||||
|
||||
Atom is only available for 64-bit Linux systems.
|
||||
|
||||
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):
|
||||
```sh
|
||||
sudo apt install git libasound2 libcurl4 libgbm1 libgcrypt20 libgtk-3-0 libnotify4 libnss3 libglib2.0-bin xdg-utils libx11-xcb1 libxcb-dri3-0 libxss1 libxtst6 libxkbfile1
|
||||
```
|
||||
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. -->
|
||||
Currently, to get binaries based on code by the Atom community, binaries can be downloaded from the [Azure Pipeline](https://dev.azure.com/atomcommunity/atomcommunity/_build/latest?definitionId=10&branchName=master). From this pipeline, the latest run can be selected. From there, the `8 published` link should be selected to download the files.
|
||||
Loading…
Reference in New Issue
Block a user