From c5175aa7d726f402b23d07a4363277b83fc68eaa Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Fri, 15 Feb 2019 17:03:57 +0800 Subject: [PATCH] Update installation and nightly guide * Fix improper indentations made obvious by the widen viewport * Fix minor grammar issues + Add installation for nightly build using dotnet CLI --- docs/guides/getting_started/installing.md | 58 +++++++++++++---------- docs/guides/getting_started/nightlies.md | 17 +++++-- 2 files changed, 47 insertions(+), 28 deletions(-) diff --git a/docs/guides/getting_started/installing.md b/docs/guides/getting_started/installing.md index bb2592c02..f34032cb2 100644 --- a/docs/guides/getting_started/installing.md +++ b/docs/guides/getting_started/installing.md @@ -42,37 +42,45 @@ published to our [MyGet feed]. See ### [Using Visual Studio](#tab/vs-install) -1. Create a new solution for your bot. +1. Create a new solution for your bot 2. In the Solution Explorer, find the "Dependencies" element under your - bot's project. -3. Right click on "Dependencies", and select "Manage NuGet packages." - ![Step 3](images/install-vs-deps.png) -4. In the "Browse" tab, search for `Discord.Net`. -5. Install the `Discord.Net` package. - ![Step 5](images/install-vs-nuget.png) + bot's project +3. Right click on "Dependencies", and select "Manage NuGet packages" + + ![Step 3](images/install-vs-deps.png) + +4. In the "Browse" tab, search for `Discord.Net` +5. Install the `Discord.Net` package + + ![Step 5](images/install-vs-nuget.png) ### [Using JetBrains Rider](#tab/rider-install) -1. Create a new solution for your bot. -2. Open the NuGet window (Tools > NuGet > Manage NuGet packages for - Solution). -![Step 2](images/install-rider-nuget-manager.png) -3. In the "Packages" tab, search for `Discord.Net`. -![Step 3](images/install-rider-search.png) -4. Install by adding the package to your project. -![Step 4](images/install-rider-add.png) +1. Create a new solution for your bot +2. Open the NuGet window (Tools > NuGet > Manage NuGet packages for Solution) + + ![Step 2](images/install-rider-nuget-manager.png) + +3. In the "Packages" tab, search for `Discord.Net` + + ![Step 3](images/install-rider-search.png) + +4. Install by adding the package to your project + + ![Step 4](images/install-rider-add.png) ### [Using Visual Studio Code](#tab/vs-code) -1. Create a new project for your bot. -2. Add `Discord.Net` to your .csproj. +1. Create a new project for your bot +2. Add `Discord.Net` to your `*.csproj` [!code[Sample .csproj](samples/project.xml)] ### [Using dotnet CLI](#tab/dotnet-cli) -1. Open command-line and navigate to where your .csproj is located. -2. Enter `dotnet add package Discord.Net`. +1. Launch your terminal +2. Navigate to where your `*.csproj` is located +3. Enter `dotnet add package Discord.Net` *** @@ -115,16 +123,16 @@ by installing one or more custom packages as listed below. 1. Install or compile the following packages: - * `Discord.Net.Providers.WS4Net` - * `Discord.Net.Providers.UDPClient` (Optional) - * This is _only_ required if your bot will be utilizing voice chat. + * `Discord.Net.Providers.WS4Net` + * `Discord.Net.Providers.UDPClient` (Optional) + * This is _only_ required if your bot will be utilizing voice chat. 2. Configure your [DiscordSocketClient] to use these custom providers over the default ones. - * To do this, set the `WebSocketProvider` and the optional - `UdpSocketProvider` properties on the [DiscordSocketConfig] that you - are passing into your client. + * To do this, set the `WebSocketProvider` and the optional + `UdpSocketProvider` properties on the [DiscordSocketConfig] that you + are passing into your client. [!code-csharp[Example](samples/netstd11.cs)] diff --git a/docs/guides/getting_started/nightlies.md b/docs/guides/getting_started/nightlies.md index 39bcc1c9f..d3844be1c 100644 --- a/docs/guides/getting_started/nightlies.md +++ b/docs/guides/getting_started/nightlies.md @@ -31,22 +31,33 @@ The following is the feed link of Discord.Net, Depending on which IDE you use, there are many different ways of adding the feed to your package source. -### [Visual Studio](#tab/vs) +### [Using Visual Studio](#tab/vs) 1. Go to `Tools` > `NuGet Package Manager` > `Package Manager Settings` + ![VS](images/nightlies-vs-step1.png) + 2. Go to `Package Sources` + ![Package Sources](images/nightlies-vs-step2.png) + 3. Click on the add icon 4. Fill in the desired name and source as shown below and hit `Update` + ![Add Source](images/nightlies-vs-step4.png) > [!NOTE] -> Remember to tick the `Include prerelease` checkbox to see the +> Remember to tick the `Include pre-release` checkbox to see the > nightly builds! > ![Checkbox](images/nightlies-vs-note.png) -### [Local NuGet.Config](#tab/local-nuget-config) +### [Using dotnet CLI](#tab/cli) + +1. Launch your terminal +2. Navigate to where your `*.csproj` is located +3. Type `dotnet add package Discord.Net --source https://www.myget.org/F/discord-net/api/v3/index.json` + +### [Using Local NuGet.Config](#tab/local-nuget-config) If you plan on deploying your bot or developing outside of Visual Studio, you will need to create a local NuGet configuration file for