Skip to content

Correcting docs for building in Linux #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eerhardt merged 7 commits into from
May 8, 2018
Merged

Correcting docs for building in Linux #58

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b6fb2d4
Correcting docs for building in linux
May 7, 2018
70a5cd7
Adding more description
May 7, 2018
6f95b01
Providing link for further information
May 7, 2018
921ec5d
Improving docs
May 8, 2018
846e5e7
Making less ubuntu centric.
May 8, 2018
8ea572f
Adding pre-req link for macOS
May 8, 2018
27790ff
Improving sentences
May 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions Documentation/building/unix-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,48 @@ For more information about the different options when building, run `build.sh -?

## Minimum Hardware Requirements
- 2GB RAM

@eerhardt eerhardt May 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add x64 here as well? We only support building on an x64 machine.

@justinormont justinormont May 8, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend adding ./ as "run ./build.sh -? " to remind users that they will need it.

- x64

## Prerequisites (native build)
## Prerequisites

### Linux

First, the package lists might need to be updated
On Linux, the following components are needed:

`sudo apt-get update`
* git
* clang-3.9
* cmake 2.8.12
* libunwind8
* curl
* All the requirements necessary to run .NET Core 2.0 applications

@safern safern May 7, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to add the command to get all this? So that people can just copy and paste? Just like in corefx:

https://github.com/dotnet/corefx/blob/master/Documentation/building/unix-instructions.md#native-build

@maryamariyan maryamariyan May 7, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@safern how about I point to https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x instead for a more comprehensive list (listing not only ubuntu)?


On Linux, the following components are needed
e.g. for Ubuntu 14.04, follow the steps below:

* CMake on the PATH
* Clang 3.5+ (same requirements as coreclr/corefx)
* All the requirements necessary to run .NET Core 2.0 applications
* libunwind
* curl
```sh
sudo apt-get update
sudo apt-get install git clang-3.9 cmake libunwind8 curl
```

Follow instructions on how to [install .NET Core SDK 2.0+ on Ubuntu](https://www.microsoft.com/net/learn/get-started/linux/ubuntu14-04):

```sh
#Register Microsoft key and feed
wget -q packages-microsoft-prod.deb https://packages.microsoft.com/config/ubuntu/14.04/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
#Install the SDK
sudo apt-get install apt-transport-https
sudo apt-get update
sudo apt-get install dotnet-sdk-2.1.105
```

For more detailed info click [here](https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x).

### macOS

macOS 10.12 or higher is needed to build dotnet/machinelearning.

On macOS a few components are needed which are not provided by a default developer setup:
* CMake
* cmake 3.10.3

One way of obtaining CMake is via [Homebrew](http://brew.sh):
```sh
Expand Down