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
merged 7 commits into from
May 8, 2018
Merged

Correcting docs for building in Linux #58

Changes from all 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
33 changes: 20 additions & 13 deletions Documentation/building/unix-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,44 @@ Building ML.NET on Linux and macOS
3. Navigate to the `machinelearning` directory
4. Run the build script `./build.sh`

Calling the script `build.sh` builds both the native and managed code.
Calling the script `./build.sh` builds both the native and managed code.

For more information about the different options when building, run `build.sh -?` and look at examples in the [developer-guide](../project-docs/developer-guide.md).
For more information about the different options when building, run `./build.sh -?` and look at examples in the [developer-guide](../project-docs/developer-guide.md).

## Minimum Hardware Requirements
- 2GB RAM
Copy link
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.

Copy link
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
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: libssl1.0.0 (1.0.2 for Debian 9) and libicu5x (libicu52 for ubuntu 14.x, libicu55 for ubuntu 16.x, and libicu57 for ubuntu 17.x). For more information on prerequisites in different linux distributions click [here](https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x).

On Linux, the following components are needed
e.g. for Ubuntu 16.x:

* 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
sudo apt-get install libssl1.0.0 libicu55
```

### 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
* All the requirements necessary to run .NET Core 2.0 applications. To view macOS prerequisites click [here](https://docs.microsoft.com/en-us/dotnet/core/macos-prerequisites?tabs=netcore2x).

One way of obtaining CMake is via [Homebrew](http://brew.sh):
```sh
$ brew install cmake
```
```