-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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.
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
Conversation
Related to: dotnet#57
* curl | ||
* All the requirements necessary to run .NET Core 2.0 applications |
There was a problem hiding this comment.
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:
There was a problem hiding this comment.
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)?
* libunwind | ||
* git | ||
* clang-3.9 | ||
* cmake |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be good to list a minimum cmake version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here and in the macOS section.
@@ -14,21 +14,18 @@ For more information about the different options when building, run `build.sh -? | |||
## Minimum Hardware Requirements | |||
- 2GB RAM |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than one question, looks good to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
### Linux | ||
|
||
First, the package lists might need to be updated | ||
For Ubuntu, the following components are needed: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We get pretty heavily into Ubuntu here, but no other distro. It almost makes it sound like we only support building on Ubuntu, which isn't the case.
Can we just list our direct dependencies (git, cmake with minimum version, clang with minimum version), and then say And all the requirements necessary to run .NET Core 2.0 applications
with the link to the docs site?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with you, my intention though was to spell out the commands and to be consistent with corefx (there is also only instructions for ubuntu).
I'll push up another commit to address this feedback.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Thanks @maryamariyan!
|
||
On Linux, the following components are needed | ||
For more information on prerequisites in different linux distribution for .NET Core on Linux click [here](https://docs.microsoft.com/en-us/dotnet/core/linux-prerequisites?tabs=netcore2x). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds redundant calling linux twice right away and in one place linux is with lower l and in the other with capital L. I would probably write it like:
For more information on prerequisites in different linux distribution for .NET Core click here
@@ -13,31 +13,40 @@ For more information about the different options when building, run `build.sh -? | |||
|
|||
## Minimum Hardware Requirements | |||
- 2GB RAM |
There was a problem hiding this comment.
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.
* Correcting docs for building in linux Related to: dotnet#57 * Adding more description * Providing link for further information * Improving docs * Making less ubuntu centric. * Adding pre-req link for macOS * Improving sentences
This PR updates the unix instructions for building this repo on Linux.
As prerequisite we need to use clang-3.9 in order to build machinelearning repo on Linux.
cc: @eerhardt @danmosemsft @safern
Related to: #57