From 6f0c6718533eddf03808260763afad2f321632ae Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Wed, 30 Mar 2016 14:30:13 -0700 Subject: [PATCH] Document OS X dependency installation instructions --- README.md | 8 -------- docs/building/osx.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 8 deletions(-) create mode 100644 docs/building/osx.md diff --git a/README.md b/README.md index 7d03349b8d..562ba37621 100644 --- a/README.md +++ b/README.md @@ -64,14 +64,6 @@ interface type 'Microsoft.Cci.ISymUnmanagedWriter5'`, please install [redist]: https://www.microsoft.com/en-hk/download/details.aspx?id=48145 -### OS X - -The OS X dependency installation instructions are not yet documented. You can -try their PKG installer, or their [obtain script][]. We do not (yet) routinely -test on OS X, but some developers use PowerShell on 10.10 and 10.11. - -[obtain script]: https://github.com/dotnet/cli/blob/rel/1.0.0/scripts/obtain/install.sh - ## Building **The command `dotnet restore` must be done at least once from the top directory diff --git a/docs/building/osx.md b/docs/building/osx.md new file mode 100644 index 0000000000..f23a0694c7 --- /dev/null +++ b/docs/building/osx.md @@ -0,0 +1,37 @@ +Build PowerShell on OS X +======================== + +This guide supplements the [Linux instructions](./linux.md), as +building on OS X is almost identical. + +Please keep in mind that we do not yet routinely test on OS X, but +some developers use PowerShell on 10.10 and 10.11. + +Environment +=========== + +You will want [Homebrew](http://brew.sh/), the missing package manager +for OS X. Once installed, use `brew` to install the following +dependencies. + +```sh +brew install openssl cmake wget +``` + +Instead of using .NET CLI's Ubuntu package feed, you will want to use +the official PKG installer. + +```sh +wget https://dotnetcli.blob.core.windows.net/dotnet/beta/Installers/Latest/dotnet-dev-osx-x64.latest.pkg +open ./dotnet-dev-osx-x64.latest.pkg +``` + +Then follow the wizard's instructions to complete installation. + +Build using our module +====================== + +Instead of installing the Ubuntu package of PowerShell, download the +`pkg` from our GitHub releases page using your browser, complete the +wizard, start a `powershell` session, and use `Start-PSBuild` from the +module.