Browse Source

Update ReadMe

pull/555/merge
Christoph Ruegg 8 years ago
parent
commit
002196f739
  1. 42
      README.md

42
README.md

@ -15,7 +15,7 @@ Math.NET Numerics is covered under the terms of the [MIT/X11](LICENSE.md) licens
* [Documentation](https://numerics.mathdotnet.com) | [API Reference](https://numerics.mathdotnet.com/api/)
* [Issues & Bugs](https://github.com/mathnet/mathnet-numerics/issues) | [Ideas](http://feedback.mathdotnet.com/forums/2060-math-net-numerics)
* [Discussions](https://discuss.mathdotnet.com/c/numerics) | [Stack Overflow](https://stackoverflow.com/questions/tagged/mathdotnet) | [Twitter](https://twitter.com/MathDotNet)
* [Wikipedia](https://en.wikipedia.org/wiki/Math.NET_Numerics) | [OpenHUB](https://www.ohloh.net/p/mathnet)
* [Wikipedia](https://en.wikipedia.org/wiki/Math.NET_Numerics) | [OpenHUB](https://www.openhub.net/p/mathnet-numerics)
### Current Version
@ -31,15 +31,14 @@ The recommended way to get Math.NET Numerics is to use NuGet. The following pack
Core Package:
- **MathNet.Numerics** - core package, including .Net 4, .Net 3.5 and portable/PCL builds.
- **MathNet.Numerics**
- **MathNet.Numerics.FSharp** - optional extensions for a better F# experience. BigRational.
- **MathNet.Numerics.Signed** - strong-named version of the core package *(not recommended)*.
- **MathNet.Numerics.FSharp.Signed** - strong-named version of the F# package *(not recommended)*.
Alternative Provider Packages (optional):
- **MathNet.Numerics.MKL.Win-x86** - Native Intel MKL Linear Algebra provider (Windows/32-bit).
- **MathNet.Numerics.MKL.Win-x64** - Native Intel MKL Linear Algebra provider (Windows/64-bit).
- **MathNet.Numerics.MKL.Win** - Native Intel MKL Linear Algebra provider (Windows).
- **MathNet.Numerics.MKL.Win-x86** - Native Intel MKL Linear Algebra provider (Windows/32-bit only).
- **MathNet.Numerics.MKL.Win-x64** - Native Intel MKL Linear Algebra provider (Windows/64-bit only).
Data/IO Packages for reading and writing data (optional):
@ -51,9 +50,13 @@ Platform Support and Dependencies
Supported Platforms:
- .Net 4.0, .Net 3.5 and Mono: Windows, Linux and Mac.
- PCL Portable Profiles 7, 47, 78, 259 and 328: Windows 8, Silverlight 5, Windows Phone/SL 8, Windows Phone 8.1.
- Xamarin: Android, iOS
- .Net Framework 4.0 or higher and Mono (Package includes builds for 4.0 and 4.6.1)
- .Net Standard 1.3 or higher (Package includes builds for 1.3 and 2.0)
Supported Platforms for the F# extensions:
- .Net Framework 4.5 or higher (Package includes builds for 4.5)
- .Net Standard 1.6 or higher (Package includes builds for 1.6 and 2.0)
For full details, dependencies and platform discrepancies see [Platform Compatibility](https://numerics.mathdotnet.com/Compatibility.html).
@ -63,19 +66,22 @@ Building Math.NET Numerics
Windows (.Net): [![AppVeyor build status](https://ci.appveyor.com/api/projects/status/79j22c061saisces/branch/master)](https://ci.appveyor.com/project/cdrnet/mathnet-numerics)
Linux (Mono): [![Travis Build Status](https://travis-ci.org/mathnet/mathnet-numerics.svg?branch=master)](https://travis-ci.org/mathnet/mathnet-numerics)
You can build Math.NET Numerics with an IDE like VisualStudio or Xamarin,
with MsBuild or with FAKE.
You can build Math.NET Numerics with an IDE like VisualStudio or JetBrains Rider, with MsBuild, .Net CLI tools or with FAKE (recommended).
MsBuild/XBuild:
FAKE:
restore.cmd (or restore.sh)
msbuild MathNet.Numerics.sln
./build.sh build (or build.cmd)
./build.sh test
FAKE:
.Net CLI:
./restore.sh (or restore.cmd)
dotnet build MathNet.Numerics.sln
build.cmd Build # build from the Windows console with .Net
./build.sh Build # build from Bash, with Mono on Linux/Mac or .Net on Windows
./build.sh Test # build and run unit tests
MsBuild/XBuild:
./restore.sh (or restore.cmd)
msbuild MathNet.Numerics.sln
See [Build & Tools](https://numerics.mathdotnet.com/Build.html) for full details
on how to build, generate documentation or even create a full release.

Loading…
Cancel
Save