updated docs and added nuget.config

MissouriMRDT · Jan 8, 2025 · 7b766c8 · 7b766c8
1 parent c06e076
commit 7b766c8
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# RoveComm C# Repo #
+# RoveComm C# #
 
 RoveComm is the communication protocol used by the Mars Rover Design Team (MRDT) at Missouri University of Science and 
 Technology (Missouri S&T). Several implementations exist for RoveComm. This implementation was made to be used with the 
@@ -10,8 +10,8 @@ The repo conains a Visual Studio 2022 solution `RoveComm_CSharp.sln`. The soluti
 
 ## RoveComm
 
-This contains the source code for the ![](rovecomm.png) [RoveComm NuGet Package](https://github.com/MissouriMRDT/RoveComm_CSharp/pkgs/nuget/RoveComm).
-For more information on RoveComm integration, look [here](RoveComm/README.md).
+This contains the source code for the ![](images/rovecomm.png) [RoveComm NuGet Package](https://github.com/MissouriMRDT/RoveComm_CSharp/pkgs/nuget/RoveComm).
+For more information on RoveComm installation and usage, look [here](RoveComm/README.md).
 
 ## RoveComm.Test
 

diff --git a/RoveComm.Test/RoveComm.Test.csproj b/RoveComm.Test/RoveComm.Test.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
@@ -10,7 +10,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.21.0" />
-    <PackageReference Include="RoveComm" Version="1.0.0" />
+    <PackageReference Include="RoveComm" Version="1.0.1" />
   </ItemGroup>
 
 </Project>
diff --git a/RoveComm/README.md b/RoveComm/README.md
@@ -7,7 +7,24 @@ with any .NET app.
 
 ## Installation
 
-**TODO: instructions for adding github as a source**
+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 <svg aria-hidden="true" viewBox="0 0 16 16" width="16" height="16" fill="currentColor" style="display: inline-block; user-select: none; vertical-align: text-bottom; overflow: visible;"><path d="M8 0a8.2 8.2 0 0 1 .701.031C9.444.095 9.99.645 10.16 1.29l.288 1.107c.018.066.079.158.212.224.231.114.454.243.668.386.123.082.233.09.299.071l1.103-.303c.644-.176 1.392.021 1.82.63.27.385.506.792.704 1.218.315.675.111 1.422-.364 1.891l-.814.806c-.049.048-.098.147-.088.294.016.257.016.515 0 .772-.01.147.038.246.088.294l.814.806c.475.469.679 1.216.364 1.891a7.977 7.977 0 0 1-.704 1.217c-.428.61-1.176.807-1.82.63l-1.102-.302c-.067-.019-.177-.011-.3.071a5.909 5.909 0 0 1-.668.386c-.133.066-.194.158-.211.224l-.29 1.106c-.168.646-.715 1.196-1.458 1.26a8.006 8.006 0 0 1-1.402 0c-.743-.064-1.289-.614-1.458-1.26l-.289-1.106c-.018-.066-.079-.158-.212-.224a5.738 5.738 0 0 1-.668-.386c-.123-.082-.233-.09-.299-.071l-1.103.303c-.644.176-1.392-.021-1.82-.63a8.12 8.12 0 0 1-.704-1.218c-.315-.675-.111-1.422.363-1.891l.815-.806c.05-.048.098-.147.088-.294a6.214 6.214 0 0 1 0-.772c.01-.147-.038-.246-.088-.294l-.815-.806C.635 6.045.431 5.298.746 4.623a7.92 7.92 0 0 1 .704-1.217c.428-.61 1.176-.807 1.82-.63l1.102.302c.067.019.177.011.3-.071.214-.143.437-.272.668-.386.133-.066.194-.158.211-.224l.29-1.106C6.009.645 6.556.095 7.299.03 7.53.01 7.764 0 8 0Zm-.571 1.525c-.036.003-.108.036-.137.146l-.289 1.105c-.147.561-.549.967-.998 1.189-.173.086-.34.183-.5.29-.417.278-.97.423-1.529.27l-1.103-.303c-.109-.03-.175.016-.195.045-.22.312-.412.644-.573.99-.014.031-.021.11.059.19l.815.806c.411.406.562.957.53 1.456a4.709 4.709 0 0 0 0 .582c.032.499-.119 1.05-.53 1.456l-.815.806c-.081.08-.073.159-.059.19.162.346.353.677.573.989.02.03.085.076.195.046l1.102-.303c.56-.153 1.113-.008 1.53.27.161.107.328.204.501.29.447.222.85.629.997 1.189l.289 1.105c.029.109.101.143.137.146a6.6 6.6 0 0 0 1.142 0c.036-.003.108-.036.137-.146l.289-1.105c.147-.561.549-.967.998-1.189.173-.086.34-.183.5-.29.417-.278.97-.423 1.529-.27l1.103.303c.109.029.175-.016.195-.045.22-.313.411-.644.573-.99.014-.031.021-.11-.059-.19l-.815-.806c-.411-.406-.562-.957-.53-1.456a4.709 4.709 0 0 0 0-.582c-.032-.499.119-1.05.53-1.456l.815-.806c.081-.08.073-.159.059-.19a6.464 6.464 0 0 0-.573-.989c-.02-.03-.085-.076-.195-.046l-1.102.303c-.56.153-1.113.008-1.53-.27a4.44 4.44 0 0 0-.501-.29c-.447-.222-.85-.629-.997-1.189l-.289-1.105c-.029-.11-.101-.143-.137-.146a6.6 6.6 0 0 0-1.142 0ZM11 8a3 3 0 1 1-6 0 3 3 0 0 1 6 0ZM9.5 8a1.5 1.5 0 1 0-3.001.001A1.5 1.5 0 0 0 9.5 8Z"></path></svg> 
+   **Settings**
+1. On the side bar, click <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" fill="currentColor" style="display: inline-block; user-select: none; vertical-align: text-bottom; overflow: visible;"><path d="m11.28 3.22 4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L13.94 8l-3.72-3.72a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215Zm-6.56 0a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042L2.06 8l3.72 3.72a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L.47 8.53a.75.75 0 0 1 0-1.06Z"></path></svg> 
+   **Developer settings**
+1. On the side bar, expand <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" fill="currentColor" style="display: inline-block; user-select: none; vertical-align: text-bottom; overflow: visible;"><path d="M10.5 0a5.499 5.499 0 1 1-1.288 10.848l-.932.932a.749.749 0 0 1-.53.22H7v.75a.749.749 0 0 1-.22.53l-.5.5a.749.749 0 0 1-.53.22H5v.75a.749.749 0 0 1-.22.53l-.5.5a.749.749 0 0 1-.53.22h-2A1.75 1.75 0 0 1 0 14.25v-2c0-.199.079-.389.22-.53l4.932-4.932A5.5 5.5 0 0 1 10.5 0Zm-4 5.5c-.001.431.069.86.205 1.269a.75.75 0 0 1-.181.768L1.5 12.56v1.69c0 .138.112.25.25.25h1.69l.06-.06v-1.19a.75.75 0 0 1 .75-.75h1.19l.06-.06v-1.19a.75.75 0 0 1 .75-.75h1.19l1.023-1.025a.75.75 0 0 1 .768-.18A4 4 0 1 0 6.5 5.5ZM11 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg> 
+   **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:**
 

diff --git a/RoveComm_CSharp.sln b/RoveComm_CSharp.sln
@@ -7,6 +7,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RoveComm", "RoveComm\RoveCo
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RoveComm.Test", "RoveComm.Test\RoveComm.Test.csproj", "{DCC336D1-3A7F-4D4F-8CFD-DC0B057525E9}"
 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
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

diff --git a/rovecomm.png → images/rovecomm.png b/rovecomm.png → images/rovecomm.png
diff --git a/nuget.config b/nuget.config
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <!--To inherit the global NuGet package sources remove the <clear/> line below -->
+    <clear />
+    <add key="nuget" value="https://api.nuget.org/v3/index.json" />
+    <add key="mrdt" value="https://nuget.pkg.github.com/MissouriMRDT/index.json" />
+  </packageSources>
+  <packageSourceCredentials>
+    <mrdt>
+      <add key="Username" value="%MRDT_GITHUB_USERNAME%" />
+      <add key="ClearTextPassword" value="%MRDT_GITHUB_TOKEN%" />
+    </mrdt>
+  </packageSourceCredentials>
+</configuration>
diff --git a/rovecomm.ico b/rovecomm.ico