github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-22 13:28:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #16473 from atom/update-docs-readme

Browse Source 
Update /docs/README.md to direct people to the new docs locations
This commit is contained in:
Lee Dohm
2018-01-01 10:15:42 -08:00
committed by GitHub
parent 8c92ed9652 d6a32c8eb6
commit c97e8f084c
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/README.md
View File

@@ -2,20 +2,20 @@
![Atom](https://cloud.githubusercontent.com/assets/72919/2874231/3af1db48-d3dd-11e3-98dc-6066f8bc766f.png)
Most of the Atom user and developer documentation is contained in the [Atom Flight Manual](https://github.com/atom/flight-manual.atom.io) repository.
In this directory you can only find very specific build and API level documentation. Some of this may eventually move to the Flight Manual as well.
Most of the Atom user and developer documentation is contained in the [Atom Flight Manual](https://github.com/atom/flight-manual.atom.io).
## Build documentation
Instructions for building Atom on various platforms from source.
* [macOS](./build-instructions/macOS.md)
* [Windows](./build-instructions/windows.md)
* [Linux](./build-instructions/linux.md)
* [FreeBSD](./build-instructions/freebsd.md)
* Moved to [the Flight Manual](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/)
* Linux
* macOS
* Windows
## Other documentation here
## Other documentation
* [apm REST API](./apm-rest-api.md)
* [Tips for contributing to packages](./contributing-to-packages.md)
[Native Profiling on macOS](./native-profiling.md)
The other documentation that was listed here previously has been moved to [the Flight Manual](https://flight-manual.atom.io).