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

Merge pull request #6942 from atom/mq-doc-build-flag

Browse Source 
Document build flags
This commit is contained in:
Machisté N. Quintana
2015-05-25 13:15:51 -04:00
parent 4bbfe37448 2e8bb9e41f
commit ed5fc35881
3 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/build-instructions/freebsd.md
View File

@@ -19,4 +19,18 @@ FreeBSD -RELEASE 64-bit is the recommended platform.
sudo script/grunt install # Installs command to /usr/local/bin/atom
```
## Advanced Options
### Custom install directory
```sh
sudo script/grunt install --install-dir /install/atom/here
```
### Custom build directory
```sh
script/build --build-dir /build/atom/here
```
## Troubleshooting

5
docs/build-instructions/os-x.md
View File

@@ -14,6 +14,11 @@
script/build # Creates application at /Applications/Atom.app
```
### `script/build` Options
* `--install-dir` - The full path to the final built application (must include `.app` in the path), e.g. `script/build --install-dir /Users/username/full/path/to/Atom.app`
* `--build-dir` - Build the application in this directory.
* `--verbose` - Verbose mode. A lot more information output.
## Troubleshooting
### OSX build error reports in atom/atom

5
docs/build-instructions/windows.md
View File

@@ -33,6 +33,11 @@ cd atom
script/build # Creates application in the `Program Files` directory
```
### `script/build` Options
* `--install-dir` - Creates the final built application in this directory.
* `--build-dir` - Build the application in this directory.
* `--verbose` - Verbose mode. A lot more information output.
## Why do I have to use GitHub for Windows?
You don't. You can use your existing Git! GitHub for Windows's Git Shell is just