Skip to content

Commit 76dd923

Browse files
authored
Updated the building instructions to specify supported VS version (#1024)
1 parent 87ffaa1 commit 76dd923

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

docs/building/windows-instructions.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ You can build ML.NET either via the command line or by using Visual Studio.
55

66
## Required Software
77

8-
1. **[Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community, Professional, Enterprise)**. The Community version is completely free.
8+
1. **[Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community, Professional, Enterprise)** The Community version is completely free. The below build instructions were verified for VS 15.8.0 and higher.
99
2. **[CMake](https://cmake.org/)** must be installed from [the CMake download page](https://cmake.org/download/#latest) and added to your path.
1010

11-
### Visual Studio 2017
11+
### Visual Studio 2017 Installation
12+
We have successfully verified the below build instructions for Visual Studio version 15.8.0 and higher.
1213

1314
#### Visual Studio 2017 - 'Workloads' based install
1415

@@ -36,10 +37,18 @@ The following are the minimum requirements:
3637
* MSBuild
3738
* .NET Framework 4.6 Targeting Pack
3839
* Windows Universal CRT SDK
39-
40-
In order to build in the Visual Studio IDE, need to call “build.cmd” from the command line first. Tests can be executed from the VS Test Explorer or command line.
41-
42-
## Building From the Command Line
40+
41+
## Building Instructions
42+
43+
### Building From Visual Studio 2017
44+
45+
First, set up the required tools, from a (non-admin) Command Prompt window:
46+
47+
- `build.cmd` - sets up tools and builds the assemblies
48+
49+
After successfully running the command, the project can be build directly from the Visual Studio IDE. Tests can be executed from the VS Test Explorer or command line.
50+
51+
### Building From the Command Line
4352

4453
You can use the Developer Command Prompt, Powershell or work in any regular cmd. The Developer Command Prompt will have a name like "Developer Command Prompt for VS 2017" or similar in your start menu.
4554

@@ -51,16 +60,18 @@ From a (non-admin) Command Prompt window:
5160

5261
**Note**: Before working on individual projects or test projects you **must** run `build.cmd` from the root once before beginning that work. It is also a good idea to run `build.cmd` whenever you pull a large set of unknown changes into your branch.
5362

63+
## Running Tests
64+
65+
### Running tests from Visual Studio
66+
67+
After successfully building, run tests in the Visual Studio Test Explorer window.
68+
5469
### Running tests from the command line
5570

5671
From the root, run `build.cmd` and then `build.cmd -runTests`.
5772
For more details, or to test an individual project, you can navigate to the test project directory and then use `dotnet test`
58-
59-
### Running tests from Visual Studio
60-
61-
You need to run tests in the Test Explorer window.
6273

63-
### Known Issues
74+
## Known Issues
6475

6576
CMake 3.7 or higher is required for Visual Studio 2017.
6677

0 commit comments

Comments
 (0)