From 32945f6b9f7ca5ff18180b4b55af040c1cd9bb1b Mon Sep 17 00:00:00 2001 From: DarthAffe Date: Fri, 13 Nov 2015 10:43:13 +0100 Subject: [PATCH] Added some content --- Adding-CUE.NET-to-a-project.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/Adding-CUE.NET-to-a-project.md b/Adding-CUE.NET-to-a-project.md index 30404ce..6686424 100644 --- a/Adding-CUE.NET-to-a-project.md +++ b/Adding-CUE.NET-to-a-project.md @@ -1 +1,25 @@ -TODO \ No newline at end of file +**CUE.NET works for both x86 and x64 architecture but requires the .NET-Framework 4.5 or newer.** + +There is more than one way to add CUE.NET to your project. The following describes the most common ones: + +## Adding the reference using NuGet ## +This is the easiest and therefore preferred way to include CUE.NET in your project. + +_Just add CUE.NET from the nuget.org repository to you project using the NuGet Package Manager included in Visual Studio. Only stable packages are published to nuget.org so they should always be safe to use. +//TODO Cue.NET is currently not published to NuGet.org - add link and remove this comment once it's done._ + +If you want to use a development version you can get them from the [CUE.NET MyGet gallery](https://www.myget.org/gallery/cue_net) by adding the feed as a package source to your Visual Studio. +_You need to check "Include prerelease" to see the package in Visual Studio._ + +## Downloading the latest release and adding it by hand ## +This will lead to the same result as using the latest package from nuget.org but requires more work: + +1. Download and unpack the latest version from [https://github.com/DarthAffe/CUE.NET/releases/latest](https://github.com/DarthAffe/CUE.NET/releases/latest). +2. Add the CUE.NET.dll as a reference to your project. +3. Make sure the x86 and x64 folder are copied to your application directory (e.g. by adding them as a solution item and creating a post-build event to copy them on build) + +## Building CUE.NET on your own ## +**Building CUE.NET requires the roslyn compiler and therefore Visual Studio 2015 or newer!** + +Of course you have always the possibility to get the [CUE.NET source code](https://github.com/DarthAffe/CUE.NET) from github and modify (respecting the LGPL v2.1) or build it on your own. +The build process is straightforward. If you have any problems doing it you should consider using the binaries.