deploy: 9ec572c

index.html

@@ -98,9 +98,17 @@
   <div class="headertitle"><div class="title">Sturdy Path </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p ><a class="anchor" id="md__github_workspace_README"></a> Sturdy Path is a Godot .NET addon that provides a way to reference a scene or resource by path, in a manner that won't break when moving files around within the project. This is accomplished by keeping track of the target file's <code>uid://</code> path, which is invariant of the file's location within the project.</p>
+<div class="textblock"><p ><a class="anchor" id="md__github_workspace_README"></a> <a href="https://github.com/mpewsey/SturdyPath/actions/workflows/tests.yml"><img src="https://github.com/mpewsey/SturdyPath/actions/workflows/tests.yml/badge.svg" alt="Tests" style="pointer-events: none;" class="inline"/></a> <a href="https://github.com/mpewsey/SturdyPath/actions/workflows/docs.yml"><img src="https://github.com/mpewsey/SturdyPath/actions/workflows/docs.yml/badge.svg?event=push" alt="Docs" style="pointer-events: none;" class="inline"/></a> <img src="https://img.shields.io/badge/Godot%20.NET-4.2-blue" alt="Godot .NET 4.0" class="inline"/> <img src="https://img.shields.io/github/v/tag/mpewsey/SturdyPath?label=Version" alt="Version" class="inline"/></p>
+<p >Sturdy Path is a simple Godot addon that provides a way to reference a scene or resource by path, in a manner that won't break when moving files around within the project. This is accomplished by keeping track of the target file's <code>uid://</code> path, which is invariant of the file's location within the project.</p>
 <p ><img src="https://github.com/user-attachments/assets/5efec515-aa99-4f41-a93e-d01a8d8e5a43" alt="image" class="inline"/></p>
 <h1><a class="anchor" id="autotoc_md1"></a>
+Installation</h1>
+<ol type="1">
+<li>Copy the <code>addons/mpewsey.sturdypath</code> directory from this repository into the <code>addons</code> folder of your Godot project.</li>
+<li>Build your Godot project solution, so that the newly incorporated C# addon scripts are compiled.</li>
+<li>Enable the addon by going to <code>Project &gt; Project Settings</code> and clicking the enable checkbox next to the plugin.</li>
+</ol>
+<h1><a class="anchor" id="autotoc_md2"></a>
 Example Usage</h1>
 <div class="fragment"><div class="line">{BattleEffect.cs} </div>
 <div class="line">using MPewsey.SturdyPath;</div>

navtreedata.js

@@ -26,7 +26,8 @@ var NAVTREE =
 [
   [ "SturdyPath", "index.html", [
     [ "Sturdy Path", "index.html", [
-      [ "Example Usage", "index.html#autotoc_md1", null ]
+      [ "Installation", "index.html#autotoc_md1", null ],
+      [ "Example Usage", "index.html#autotoc_md2", null ]
     ] ],
     [ "Packages", "namespaces.html", [
       [ "Packages", "namespaces.html", "namespaces_dup" ]

navtreeindex0.js

@@ -12,22 +12,22 @@ var NAVTREEINDEX0 =
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a17daee0ad0af91cf977545764c54ce8a":[1,0,0,0,0,4],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a3d665ebae284fbfdd65cc6a31c93c5af":[2,0,0,0,0,1],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a3d665ebae284fbfdd65cc6a31c93c5af":[1,0,0,0,0,1],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a45a1edf30521e856c66a5fcdd0736fcf":[1,0,0,0,0,12],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a45a1edf30521e856c66a5fcdd0736fcf":[2,0,0,0,0,12],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a52827c00253a20b4d23077f5d402170e":[1,0,0,0,0,0],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a45a1edf30521e856c66a5fcdd0736fcf":[1,0,0,0,0,12],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a52827c00253a20b4d23077f5d402170e":[2,0,0,0,0,0],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a52827c00253a20b4d23077f5d402170e":[1,0,0,0,0,0],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5b27376800f54c862ac710cc65936a24":[1,0,0,0,0,2],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5b27376800f54c862ac710cc65936a24":[2,0,0,0,0,2],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5dd75a0f9e722c757a41935133e8d107":[2,0,0,0,0,7],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5dd75a0f9e722c757a41935133e8d107":[1,0,0,0,0,7],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a5dd75a0f9e722c757a41935133e8d107":[2,0,0,0,0,7],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a9601718a5dd84e154e7f489f8ac2b4f1":[1,0,0,0,0,9],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#a9601718a5dd84e154e7f489f8ac2b4f1":[2,0,0,0,0,9],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#aa9dafb6e480f1d61eb50585a094baacb":[1,0,0,0,0,11],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#aa9dafb6e480f1d61eb50585a094baacb":[2,0,0,0,0,11],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#aa9dafb6e480f1d61eb50585a094baacb":[1,0,0,0,0,11],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#abe0f624dd84799e13f0161d1ccf457c3":[2,0,0,0,0,8],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#abe0f624dd84799e13f0161d1ccf457c3":[1,0,0,0,0,8],
-"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ace1ebe7a20119d26725ebe592a23e5bd":[2,0,0,0,0,10],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ace1ebe7a20119d26725ebe592a23e5bd":[1,0,0,0,0,10],
+"class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ace1ebe7a20119d26725ebe592a23e5bd":[2,0,0,0,0,10],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ad5ee1c8c52082051ae333ca863af4dbc":[2,0,0,0,0,5],
 "class_m_pewsey_1_1_sturdy_path_1_1_sturdy_path_ref.html#ad5ee1c8c52082051ae333ca863af4dbc":[1,0,0,0,0,5],
 "classes.html":[2,1],
@@ -41,9 +41,10 @@ var NAVTREEINDEX0 =
 "functions_prop.html":[2,3,3],
 "functions_vars.html":[2,3,2],
 "hierarchy.html":[2,2],
-"index.html":[0],
 "index.html":[],
+"index.html":[0],
 "index.html#autotoc_md1":[0,0],
+"index.html#autotoc_md2":[0,1],
 "namespace_m_pewsey.html":[1,0,0],
 "namespace_m_pewsey_1_1_sturdy_path.html":[1,0,0,0],
 "namespaces.html":[1,0],