pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2025-01-07 23:59:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update readme and build instructions

Browse Source
This commit is contained in:
probablycorey 2013-11-27 10:59:11 -08:00
parent a190a069c1
commit 9fe507d675
2 changed files with 10 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,30 +1,17 @@
# Atom — Futuristic Text Editing # Atom — The hackable, ~~collaborative~~ editor of tomorrow!
![atom](https://s3.amazonaws.com/speakeasy/apps/icons/27/medium/7db16e44-ba57-11e2-8c6f-981faf658e00.png) ![Atom](https://www.atom.io/assets/logo-e793a022e41eff6879fd6205bc06ef92.png)
Check out our [guides](https://www.atom.io/docs/latest/) and [API documentation](https://www.atom.io/docs/api/v34.0.0/api/) Check out our [guides and API documentation](https://www.atom.io/docs/latest/)
## Installing ## Installing
Download the latest Atom release from [speakeasy](https://speakeasy.githubapp.com/apps/27). Download the latest [Atom release](https://github.com/atom/atom/releases/latest).
It will automatically update when a new release is available. Atom will automatically update when a new release is available.
## Building ## Building
### Requirements Follow the instructions in the [build docs][building]
* Mountain Lion
* Looking for Windows support? Read [here][building].
* Boxen (Obviously Atom won't release with this requirement)
### Installation
1. `gh-setup atom`
2. `cd ~/github/atom`
3. `script/build`
[building]: https://github.com/atom/atom/blob/master/docs/building-atom.md [building]: https://github.com/atom/atom/blob/master/docs/building-atom.md

7
docs/building-atom.md
View File

@ -6,10 +6,11 @@ atom][download].
## OSX ## OSX
* Use Mountain Lion * Use OS X 10.8 or later
* Install the latest node 0.10.x release (32bit preferable) * Install the latest node 0.10.x release (32bit preferable)
* Install cmake
* Clone [atom][atom-git] to `~/github/atom` * Clone [atom][atom-git] to `~/github/atom`
* Run `~/github/atom/script/bootstrap` * Run `~/github/atom/script/build`
## Windows ## Windows
@ -26,7 +27,7 @@ atom][download].
* Use the Windows GitHub shell and cd into `C:\Users\<user>\github\atom` * Use the Windows GitHub shell and cd into `C:\Users\<user>\github\atom`
* Run `script\bootstrap` * Run `script\bootstrap`
[download]: http://www.atom.io [download]: https://github.com/atom/atom/releases/latest
[win-node]: http://nodejs.org/download/ [win-node]: http://nodejs.org/download/
[win-python]: http://www.python.org/download/ [win-python]: http://www.python.org/download/
[win-github]: http://windows.github.com/ [win-github]: http://windows.github.com/