diff --git a/Build.html b/Build.html index 6d34ab6d..0f4b7770 100644 --- a/Build.html +++ b/Build.html @@ -67,21 +67,19 @@ run restore.cmd or restore.sh once after every git che the dependencies exactly as defined. Otherwise Visual Studio and other IDEs may fail to compile or provide correct IntelliSense.

Tests can be run with the usual integrated NUnit test runners or ReSharper.

-

MSBuild or XBuild

+

Command Line Tools

Instead of a compatible IDE you can also build the solutions directly with -msbuild, or on Mono with xbuild. You may need to run restore.cmd or +the .NET Core SDK, with MsBuild or on Mono with XBuild. You may need to run restore.cmd or restore.sh before, once after every git checkout in order to restore the dependencies.

1: 
 2: 
 3: 
 4: 
-5: 
 
restore.cmd (or restore.sh)             # restore dependencies (once)
-msbuild MathNet.Numerics.sln            # only build for .Net 4 (main solution)
-msbuild MathNet.Numerics.Net35Only.sln  # only build for .Net 3.5
-msbuild MathNet.Numerics.All.sln        # full build with .Net 4, 3.5 and PCL profiles
-xbuild MathNet.Numerics.sln             # build with Mono, e.g. on Linux or Mac
+dotnet build MathNet.Numerics.sln       # with .NET Core SDK
+msbuild MathNet.Numerics.sln            # with MsBuild
+xbuild MathNet.Numerics.sln             # with Mono
@@ -105,39 +103,21 @@ is not required when using Visual Studio or msbuild direct 12: 13: 14: -15: -16: -17: -18: -19: -20: -21: -22: -23: -
build.cmd    # normal build (.Net 4.0), run unit tests (.Net on Windows)
-./build.sh   # normal build (.Net 4.0), run unit tests (Mono on Linux/Mac, .Net on Windows)
+
./build.sh   # normal build and unit tests, when using bash shell on Windows or Linux.
+build.cmd    # normal build and unit tests, when using Windows CMD shell.
 
-build.cmd Build              # normal build (.Net 4.0)
-build.cmd Build incremental  # normal build, incremental (.Net 4.0)
-build.cmd Build all          # full build (.Net 4.0, 3.5, PCL)
-build.cmd Build net35        # compatibility build (.Net 3.5
-build.cmd Build signed       # normal build, signed/strong named (.Net 4.0)
+./build.sh build              # normal build
+./build.sh build strongname   # normal build and also build strong named variant
 
-build.cmd Test          # normal build (.Net 4.0), run unit tests
-build.cmd Test quick    # normal build (.Net 4.0), run unit tests except long running ones
-build.cmd Test all      # full build (.Net 4.0, 3.5, PCL), run all unit tests
-build.cmd Test net35    # compatibility build (.Net 3.5), run unit tests
+./build.sh test          # normal build (.Net 4.0), run unit tests
+./build.sh test quick    # normal build (.Net 4.0), run unit tests except long running ones
 
-build.cmd Clean         # cleanup build artifacts
-build.cmd Docs          # generate documentation
-build.cmd Api           # generate api reference
-build.cmd Zip           # generate zip packages (.Net 4.0)
-build.cmd NuGet         # generate NuGet packages (.Net 4.0)
-build.cmd NuGet all     # generate normal NuGet packages (.Net 4.0, 3.5, PCL)
-build.cmd NuGet signed  # generate signed/strong named NuGet packages (.Net 4.0)
+./build.sh clean         # cleanup build artifacts
+./build.sh docs          # generate documentation
+./build.sh api           # generate api reference
 
-build.cmd All           # build, test, docs, api reference (.Net 4.0)
+./build.sh all           # build, test, docs, api reference
 

 
 
@@ -148,19 +128,18 @@ is not required when using Visual Studio or msbuild direct
 
We manage NuGet and other dependencies with Paket.
 You do not normally have to do anything with Paket as it is integrated into our
 FAKE build tools, unless you want to actively manage the dependencies.

-
You can bootstrap or update Paket by calling tools/paket/paket.bootstrapper.exe.
-After bootstrapping, tools/paket/paket.exe restore will restore the packages
+
.paket/paket.exe restore will restore the packages
 to the exact version specified in the paket.lock file,
-tools/paket/paket.exe install will install or migrate packages after you have
-made changes to the paket.dependencies file, tools/paket/paket.exe outdated
-will show whether any packages are out of date and tools/paket/paket.exe update
+.paket/paket.exe install will install or migrate packages after you have
+made changes to the paket.dependencies file, .paket/paket.exe outdated
+will show whether any packages are out of date and .paket/paket.exe update
 will update all packages within the defined constraints. Have a look at the Paket
 website for more commands and details.

 
Documentation

 
This website and documentation is automatically generated from of a set of
 CommonMark structured files in doc/content/ using
 FSharp.Formatting.
-The final documentation can be built by calling build.sh Docs.

+The final documentation can be built by calling build.sh docs.

 
However, for editing and previewing the docs on your local machine it is more
 convenient to run build.sh DocsWatch in a separate console instead, which
 monitors the content files and incrementally regenerates the HTML output
@@ -178,12 +157,8 @@ document in the root directory. The fake builds pick this up and propagate it
 to the assembly info files automatically.

 
The build can then be launched by calling:

 
-
1: 
-2: 
-3: 
 
build.sh All release    # full release build
-build.sh NuGet release  # if you only need NuGet packages
-build.sh Zip release    # if you only need Zip packages
+
./build.sh all
 

 

 

@@ -223,13 +198,31 @@ Example:

 
The artifacts are then ready in the out/packages directory.

 
Extra Packages

 
In addition to the core package this repository also include extra packages
-like the MKL provider and the data extensions. Most build targets are available for
+like the data extensions. Most build targets are available for
 these packages as well, with the following prefixes:

 
-
Example: build.sh MklWinNuget release

+
Example: build.sh DataBuild

+
Intel MKL on Windows

+
The build expects that either Intel Parallel Studio 2020 (with the Intel Compiler)
+or Intel Math Kernel Library 2020 is installed. If you run into an error with mkl_link_tool.exe
+you may need to patch a targets file, see MKL 2020.1, VS2019 linking bug .

+
The build can then be triggered by calling:

+
+
+
+
1: 
+2: 
+3: 
+
./build.sh MklWinBuild  // build both 32 and 64 bit variants
+./build.sh MklTest      // run all tests with the MKL provider enforced
+./build.sh MklWinAll    // build and run tests
+

+
The build puts the binaries to out/MKL/Windows/x64 (and x86), the NuGet package
+to out/MKL/NuGet and a Zip archive to out/MKL/Zip. You can directly use the provider from
+there by setting Control.NativeProviderPath to the full path pointing to out/MKL/Windows/;
+this is also what the unit tests do when you run the MklTest build target.

 
Official Release Process (Maintainers only)