diff --git a/README.md b/README.md index 7ce8cabad..ab1e0a7fd 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,6 @@ -
- - - -

@@ -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. +
+ ![Banner] + +
+ +[![Button Install]][Install]    +[![Button Documentation]][Documentation]    +[![Button Build]][Build]  + +
+ ![Preview] +
+ 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 - -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 + + + + +[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 + + + + +[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 + diff --git a/docs/Building.md b/docs/Building.md new file mode 100644 index 000000000..456b8a384 --- /dev/null +++ b/docs/Building.md @@ -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) \ No newline at end of file diff --git a/docs/Documentation.md b/docs/Documentation.md new file mode 100644 index 000000000..20b98405f --- /dev/null +++ b/docs/Documentation.md @@ -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. \ No newline at end of file diff --git a/docs/Installation.md b/docs/Installation.md new file mode 100644 index 000000000..c9c575772 --- /dev/null +++ b/docs/Installation.md @@ -0,0 +1,45 @@ +## Installing + +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. \ No newline at end of file