From e9077beb411e9d8439b34b134f1c2bd5b4c17d22 Mon Sep 17 00:00:00 2001 From: Machiste Quintana Date: Mon, 25 May 2015 12:14:12 -0400 Subject: [PATCH 1/3] Document build flags --- docs/build-instructions/freebsd.md | 14 ++++++++++++++ docs/build-instructions/os-x.md | 5 +++++ docs/build-instructions/windows.md | 5 +++++ 3 files changed, 24 insertions(+) diff --git a/docs/build-instructions/freebsd.md b/docs/build-instructions/freebsd.md index 147c9da23..8029aa5f2 100644 --- a/docs/build-instructions/freebsd.md +++ b/docs/build-instructions/freebsd.md @@ -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 diff --git a/docs/build-instructions/os-x.md b/docs/build-instructions/os-x.md index d8685cff8..334a33653 100644 --- a/docs/build-instructions/os-x.md +++ b/docs/build-instructions/os-x.md @@ -14,6 +14,11 @@ script/build # Creates application at /Applications/Atom.app ``` +### `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. + ## Troubleshooting ### OSX build error reports in atom/atom diff --git a/docs/build-instructions/windows.md b/docs/build-instructions/windows.md index 8cfe74e72..a5d0757cb 100644 --- a/docs/build-instructions/windows.md +++ b/docs/build-instructions/windows.md @@ -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 From ae5590446576b5fbc160d24f2bdeae42ed01381d Mon Sep 17 00:00:00 2001 From: Machiste Quintana Date: Mon, 25 May 2015 12:52:03 -0400 Subject: [PATCH 2/3] :memo: Update --install-dir docs for OS X --- docs/build-instructions/os-x.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-instructions/os-x.md b/docs/build-instructions/os-x.md index 334a33653..2ffde8ec0 100644 --- a/docs/build-instructions/os-x.md +++ b/docs/build-instructions/os-x.md @@ -15,7 +15,7 @@ ``` ### `script/build` Options - * `--install-dir` - Creates the final built application in this directory. + * `--install-dir` - The full path to the final built application (must include `.app` in the path), e.g. `script/build --install-dir full/path/to/Atom.app` * `--build-dir` - Build the application in this directory. * `--verbose` - Verbose mode. A lot more information output. From 2e8bb9e41fccbbf00d3eae080c76e9631333af96 Mon Sep 17 00:00:00 2001 From: Machiste Quintana Date: Mon, 25 May 2015 13:14:00 -0400 Subject: [PATCH 3/3] :memo: Update example path --- docs/build-instructions/os-x.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-instructions/os-x.md b/docs/build-instructions/os-x.md index 2ffde8ec0..7201676b1 100644 --- a/docs/build-instructions/os-x.md +++ b/docs/build-instructions/os-x.md @@ -15,7 +15,7 @@ ``` ### `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 full/path/to/Atom.app` + * `--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.