From 48a868e6924d4156e9a2c3cea9db7a74b8f908bc Mon Sep 17 00:00:00 2001 From: Artidoro Pagnoni Date: Tue, 25 Sep 2018 10:01:26 -0700 Subject: [PATCH 1/4] updated the building instructions for windows to require VS version 15.8.4 at least --- docs/building/windows-instructions.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/building/windows-instructions.md b/docs/building/windows-instructions.md index 9ffc9c82ae..541885ca6e 100644 --- a/docs/building/windows-instructions.md +++ b/docs/building/windows-instructions.md @@ -5,10 +5,11 @@ You can build ML.NET either via the command line or by using Visual Studio. ## Required Software -1. **[Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community, Professional, Enterprise)**. The Community version is completely free. +1. **[Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community, Professional, Enterprise)** version 18.5.4 or higher. The Community version is completely free. 2. **[CMake](https://cmake.org/)** must be installed from [the CMake download page](https://cmake.org/download/#latest) and added to your path. ### Visual Studio 2017 +The minimum supported Visual Studio version is 15.8.4. #### Visual Studio 2017 - 'Workloads' based install From f85789015286aac82e09f154383854235fd1201f Mon Sep 17 00:00:00 2001 From: Artidoro Pagnoni Date: Mon, 1 Oct 2018 14:11:30 -0700 Subject: [PATCH 2/4] corrected readme --- docs/building/windows-instructions.md | 37 +++++++++++++++++++-------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/docs/building/windows-instructions.md b/docs/building/windows-instructions.md index 541885ca6e..27ff021023 100644 --- a/docs/building/windows-instructions.md +++ b/docs/building/windows-instructions.md @@ -5,11 +5,11 @@ You can build ML.NET either via the command line or by using Visual Studio. ## Required Software -1. **[Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community, Professional, Enterprise)** version 18.5.4 or higher. The Community version is completely free. +1. **[Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community, Professional, Enterprise)** The Community version is completely free. The bellow build instructions were verified for VS 15.8.0 and higher. 2. **[CMake](https://cmake.org/)** must be installed from [the CMake download page](https://cmake.org/download/#latest) and added to your path. -### Visual Studio 2017 -The minimum supported Visual Studio version is 15.8.4. +### Visual Studio 2017 Installation +We have successfully verified the following build instructions for Visual Studio version 15.8.0 and higher. #### Visual Studio 2017 - 'Workloads' based install @@ -37,10 +37,19 @@ The following are the minimum requirements: * MSBuild * .NET Framework 4.6 Targeting Pack * Windows Universal CRT SDK - -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. - -## Building From the Command Line +_____________________ + +## Building Instructions + +### Building From Visual Studio 2017 + +First, set up the required tools, from a (non-admin) Command Prompt window: + +- `build.cmd` - sets up tools and builds the assemblies + +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. + +### Building From the Command Line 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. @@ -52,16 +61,22 @@ From a (non-admin) Command Prompt window: **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. +_____________________ + +## Running Tests + +### Running tests from Visual Studio + +After successfully building, run tests in the Visual Studio Test Explorer window. + ### Running tests from the command line From the root, run `build.cmd` and then `build.cmd -runTests`. For more details, or to test an individual project, you can navigate to the test project directory and then use `dotnet test` -### Running tests from Visual Studio - -You need to run tests in the Test Explorer window. +_____________________ -### Known Issues +## Known Issues CMake 3.7 or higher is required for Visual Studio 2017. From 89f5a02c689791b7465a85591f564695078921cb Mon Sep 17 00:00:00 2001 From: Artidoro Pagnoni Date: Mon, 1 Oct 2018 14:15:29 -0700 Subject: [PATCH 3/4] visual change --- docs/building/windows-instructions.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/building/windows-instructions.md b/docs/building/windows-instructions.md index 27ff021023..b00f20c005 100644 --- a/docs/building/windows-instructions.md +++ b/docs/building/windows-instructions.md @@ -37,7 +37,6 @@ The following are the minimum requirements: * MSBuild * .NET Framework 4.6 Targeting Pack * Windows Universal CRT SDK -_____________________ ## Building Instructions @@ -61,8 +60,6 @@ From a (non-admin) Command Prompt window: **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. -_____________________ - ## Running Tests ### Running tests from Visual Studio @@ -73,8 +70,6 @@ After successfully building, run tests in the Visual Studio Test Explorer window From the root, run `build.cmd` and then `build.cmd -runTests`. For more details, or to test an individual project, you can navigate to the test project directory and then use `dotnet test` - -_____________________ ## Known Issues From ded91d82ea31642b63792696bfea5aa2c48895b0 Mon Sep 17 00:00:00 2001 From: Artidoro Pagnoni Date: Mon, 1 Oct 2018 14:18:01 -0700 Subject: [PATCH 4/4] typo --- docs/building/windows-instructions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/building/windows-instructions.md b/docs/building/windows-instructions.md index b00f20c005..7321967e04 100644 --- a/docs/building/windows-instructions.md +++ b/docs/building/windows-instructions.md @@ -5,11 +5,11 @@ You can build ML.NET either via the command line or by using Visual Studio. ## Required Software -1. **[Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community, Professional, Enterprise)** The Community version is completely free. The bellow build instructions were verified for VS 15.8.0 and higher. +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. 2. **[CMake](https://cmake.org/)** must be installed from [the CMake download page](https://cmake.org/download/#latest) and added to your path. ### Visual Studio 2017 Installation -We have successfully verified the following build instructions for Visual Studio version 15.8.0 and higher. +We have successfully verified the below build instructions for Visual Studio version 15.8.0 and higher. #### Visual Studio 2017 - 'Workloads' based install