diff --git a/RoveComm/README.md b/RoveComm/README.md index a85caba..6fa6ff7 100644 --- a/RoveComm/README.md +++ b/RoveComm/README.md @@ -7,29 +7,11 @@ with any .NET app. ## Installation -Because this package is hosted on GitHub instead of on [nuget.org](https://nuget.org), you must add an additional package -source. For that, you will need an *API key*. Follow the instructions below to create an API key: - -1. Navigate to [github.com](https://github.com) -1. Click on your profile picture in the upper corner. -1. Go to - **Settings** -1. On the side bar, click - **Developer settings** -1. On the side bar, expand - **Personal access tokens** and select **Tokens (classic)**. -1. Click **Generate new token** > **Generate new token (classic)**. 1. Find and check the box next to **read:packages**. - 1. Put whatever you want in notes and expiration date. - 1. You can ignore the other settings. -1. Scroll to the bottom and click **Generate token**. -1. ***Copy the token and save it somewhere!*** Otherwise you will need to generate a new one! - -TODO: document how to add github as a source. - **To install through Visual Studio:** -Right click on your project in Visual Studio and select `Manage NuGet Packages...`. -Go to `Browse` and search for "RoveComm". Click the down arrow next to the package version number, then click `Apply`. +In Visual Studio, make sure you have your project selected in Solution Explorer, then navigate to +`Project` > `Manage NuGet Packages...`. Go to `Browse` and search for "RoveComm". Click the down arrow next to the +package version number. Click `Apply`. **To install with the dotnet CLI:** @@ -39,6 +21,8 @@ Open terminal and `cd` into your project directory. Run the following command to dotnet add package RoveComm ``` +*If we need to migrate off the NuGet registry, we can also use [GitHub Packages](#using-with-github-packages)* + ## Adding RoveComm to your Blazor App In `Program.cs`, add the following: @@ -79,3 +63,33 @@ For further documentation of available methods, see [TODO: set up Doxygen for Ro You can see the list of boards and DataIDs in the [RoveComm_Base Repo](https://github.com/MissouriMRDT/RoveComm_Base). If you need a new packet added for any reason, contact a software lead. + +## Using With GitHub Packages + +To access the GitHub package registry, you will need *Personal Access Token*. Follow the instructions below to create a PAT: + +1. Navigate to [github.com](https://github.com) +1. Click on your profile picture in the upper corner. +1. Go to **Settings**. +1. On the side bar, click **Developer settings**. +1. On the side bar, expand **Personal access tokens** and select **Tokens (classic)**. +1. Click **Generate new token** > **Generate new token (classic)**. + 1. Find and check the box next to **read:packages**. + 1. Put whatever you want in notes and expiration date. + 1. You can ignore the other settings. +1. Scroll to the bottom and click **Generate token**. +1. ***Copy the token and save it somewhere!*** Otherwise you will need to generate a new one! + +Because this package is hosted on GitHub instead of on [nuget.org](https://nuget.org), you must add an additional package +source. This is most easily done with the dotnet CLI. + +Add GitHub as a source and name it "mrdt" (only do this once): + +```cli +dotnet nuget add source --username --password --store-password-in-clear-text --name mrdt "https://nuget.pkg.github.com/MissouriMRDT/index.json" +``` + +If you are using Visual Studio, you can manage your sources in +Tools > NuGet Package Manager > Package Manager Settings > Package Sources. + +For more information about GitHub NuGet packages, see the [official documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry). \ No newline at end of file diff --git a/RoveComm/RoveComm.csproj b/RoveComm/RoveComm.csproj index c4bb6b3..cae604b 100644 --- a/RoveComm/RoveComm.csproj +++ b/RoveComm/RoveComm.csproj @@ -7,14 +7,14 @@ missourimrdt Implementation of RoveComm for .NET Core. rovecomm.png - git + README.md + MIT https://github.com/MissouriMRDT/RoveComm_CSharp.git + git https://github.com/MissouriMRDT/RoveComm_CSharp.git MRDT;RoveComm True snupkg - False - README.md diff --git a/RoveComm/RoveComm.nuspec b/RoveComm/RoveComm.nuspec deleted file mode 100644 index 12231b6..0000000 --- a/RoveComm/RoveComm.nuspec +++ /dev/null @@ -1,18 +0,0 @@ - - - - RoveComm - 1.0.0 - RoveComm - MRDT - false - MIT - rovecomm.png - README.md - https://github.com/MissouriMRDT/RoveComm_CSharp - RoveComm implementation for the .NET Core. - Migrated RoveComm to separate repo. - missourimrdt - RoveComm MRDT - - \ No newline at end of file diff --git a/RoveComm_CSharp.sln b/RoveComm_CSharp.sln index b9b80b6..33e236b 100644 --- a/RoveComm_CSharp.sln +++ b/RoveComm_CSharp.sln @@ -9,7 +9,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RoveComm.Test", "RoveComm.T EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1A164D64-52A7-4336-85DD-3C6BCD114FDB}" ProjectSection(SolutionItems) = preProject - nuget.config = nuget.config README.md = README.md EndProjectSection EndProject diff --git a/nuget.config b/nuget.config deleted file mode 100644 index 0c5e865..0000000 --- a/nuget.config +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - -