Update docs to ref .NET Core SDK

This commit is contained in:
Rikki 2020-06-28 01:17:53 +01:00
parent 1764fb9d35
commit f56d3e3cef
2 changed files with 14 additions and 15 deletions

View File

@ -2,8 +2,7 @@
![Project logo](./res/if-lastfm-logo-300.png)
[![Code licence](https://img.shields.io/badge/licence-MIT-blue.svg?style=flat)](LICENCE.md) [![Build status](https://ci.appveyor.com/api/projects/status/c8gg2cw4jibbsg3u)](https://ci.appveyor.com/project/rikkit/lastfm) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/inflatablefriends/lastfm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Code licence](https://img.shields.io/badge/licence-MIT-blue.svg?style=flat)](LICENCE.md)
## Project Goals
@ -19,22 +18,21 @@ If you're interested in contributing code or documentation, [this short introduc
## Quickstart
### Installing the SDK
### Installing
#### NuGet - production code
#### NuGet
Install [the NuGet package](
https://www.nuget.org/packages/Inflatable.Lastfm/). Search for ```Inflatable.Lastfm``` in the NuGet package browser.
Install [Inflatable.Lastfm](
https://www.nuget.org/packages/Inflatable.Lastfm/) from NuGet.
#### NuGet - prerelease code
There is a NuGet package built for every commit to master. Add ```https://ci.appveyor.com/nuget/lastfm``` to your NuGet package sources, and install the ```IF.Lastfm.Core``` prerelease package.
1. Install the [.NET Core SDK](https://docs.microsoft.com/en-us/dotnet/core/install/sdk)
2. Clone this repo and checkout to the commit you need
3. Run `dotnet pack`
4. Reference the built NuGet package file in your project
#### From source
Clone this repo and reference ```IF.Lastfm.Core``` in your application. Your IDE needs to support C# 6 and portable libraries - Visual Studio 2015 Community or better.
### Using the SDK
### Examples
First, [sign up for Last.fm API](http://last.fm/api) access if you haven't already.

View File

@ -6,11 +6,12 @@ This document explains the process of writing code and submitting it for inclusi
## Setup
First off, you will need
First off, you will need
- a version of Visual Studio that can compile portable class libraries - unfortunately this means you can't use an Express edition of Visual Studio
- a text editor or IDE to work with C# - e.g. Visual Studio, Visual Studio Code (with OmniSharp)
- a working install of Git - the easiest way is to install [Github for Windows](https://windows.github.com/)
- Fiddler or another web request inspector - set this up so you can inspect HTTPS requests (see step 4 of [this guide](http://rikk.it/blog/capture-windows-phone-8-network-traffic-with-fiddler/))
- the [.NET Core SDK](https://docs.microsoft.com/en-us/dotnet/core/install/sdk)
- Fiddler or another web request inspector - set this up so you can inspect HTTPS requests
Once you have those installed, you can fork [the repo](https://github.com/inflatablefriends/lastfm), clone it to your machine and start work.