Skip to content

Commit

Permalink
Removed .targets and .nuspec from VS filters file and replaced with .…
Browse files Browse the repository at this point in the history
…in files. Improved README.md.
  • Loading branch information
kimlaine committed Oct 30, 2019
1 parent 7101dcb commit 36ac12f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 14 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ of the library should look at the [list of changes](Changes.md).
- [Installing Microsoft SEAL](#installing-microsoft-seal)
- [Windows](#windows)
- [Linux and macOS](#linux-and-macos)
- [From NuGet package](#from-nuget-package)
- [Enabling Optional Dependencies](#enabling-optional-dependencies)
- [Microsoft GSL](#microsoft-gsl)
- [ZLIB](#zlib)
Expand Down Expand Up @@ -110,14 +111,6 @@ the only choice.

# Installing Microsoft SEAL

## NuGet package for .NET developers
For .NET developers the easiest way of installing Microsoft SEAL is by using the
multi-platform NuGet package available at
[NuGet.org](https://www.nuget.org/packages/Microsoft.Research.SEALNet). Simply add
this package into your .NET project as a dependency and you are ready to go. However,
we still recommend reading through the below detailed installation instructions, as
they will explain how to build and run the examples that come with the source code.

## Windows

Microsoft SEAL comes with a Microsoft Visual Studio 2019 solution file `SEAL.sln`
Expand Down Expand Up @@ -259,12 +252,18 @@ cd <directory containing your CMakeLists.txt>
cmake . -DCMAKE_PREFIX_PATH=~/mylibs
````

## Enabling Optional Dependencies
## From NuGet package
For .NET developers the easiest way of installing Microsoft SEAL is by using the
multi-platform NuGet package available at
[NuGet.org](https://www.nuget.org/packages/Microsoft.Research.SEALNet). Simply add
this package into your .NET project as a dependency and you are ready to go.

# Enabling Optional Dependencies

Microsoft SEAL has no required dependencies, but certain optional features can be
enabled if it is compiled with support for specific third-party libraries.

### Microsoft GSL
## Microsoft GSL

Microsoft GSL (Guidelines Support Library) is a header-only library that implements
two convenient (templated) data types: `gsl::span` and `gsl::multi_span`. These
Expand Down Expand Up @@ -315,7 +314,7 @@ make
Note that you may need to give the same `-DMSGSL_ROOT=~/mylibs/GSL/include` hint
to CMake when configuring your own applications linking with Microsoft SEAL.

### ZLIB
## ZLIB

ZLIB is a widely used compression library that implements the DEFLATE compression
algorithm. Microsoft SEAL can use ZLIB (if present) to automatically compress data
Expand Down
4 changes: 2 additions & 2 deletions SEAL.sln
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "NuGet", "NuGet", "{33C15AAC-6E56-477E-A118-3451FD21AC49}"
ProjectSection(SolutionItems) = preProject
dotnet\nuget\NUGET.md = dotnet\nuget\NUGET.md
dotnet\nuget\SEALNet.nuspec = dotnet\nuget\SEALNet.nuspec
dotnet\nuget\SEALNet.targets = dotnet\nuget\SEALNet.targets
dotnet\nuget\SEALNet.nuspec.in = dotnet\nuget\SEALNet.nuspec.in
dotnet\nuget\SEALNet.targets.in = dotnet\nuget\SEALNet.targets.in
EndProjectSection
EndProject
Global
Expand Down
1 change: 0 additions & 1 deletion dotnet/examples/Examples.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

using Microsoft.Research.SEAL;
using System;
using System.IO;

namespace SEALNetExamples
{
Expand Down

0 comments on commit 36ac12f

Please sign in to comment.