Docs - Cleanup Download, Updating, index

OpenNaja · Mar 26, 2024 · 431e4a5 · 431e4a5
1 parent fea3d83
commit 431e4a5
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 8 deletions.
diff --git a/docs/Download.md b/docs/Download.md
@@ -2,7 +2,9 @@
 
 ## Installation
 
-**Read the instructions steps carefully and do not jump ahead and start downloading everything or you will miss important steps**.
+!!! tip
+    1. Read the instructions steps carefully before downloading anything or you will miss important steps.
+    2. If updating the tools, please also refer to [Updating](Updating.md).
 
 [Download :material-download:](https://github.com/OpenNaja/cobra-tools/archive/master.zip){ .md-button .md-button--download }
 
@@ -26,9 +28,9 @@ You need to have installed:
 
 ### Installing Python Dependencies
 
-Opening any of the GUI tools after installing Python 3.11 and the redistributables will auto-install the Python dependencies for you. You may also be prompted to update outdated packages.
+Opening any of the GUI tools after installing Python 3.11 and the redistributables will auto-install the Python dependencies for you. You may also be prompted to update outdated packages via this same prompt.
 
-![Auto Updater](assets/images/auto_updater.png)
+![Auto Updater](./assets/images/auto_updater.png)
 
 Simply follow the instructions, typing `y` and hitting `Enter`.
 

diff --git a/docs/Updating.md b/docs/Updating.md
@@ -1,16 +1,19 @@
 
 # Updating
 
+!!! warning inline inline-wide end "Mid-Project Tool Updates"
+    Updating the tools in the middle of a project may require re-extraction of files due to format changes, or the recreation of .blend files by re-importing your models.  Thus, it is recommended to avoid upgrades unless you are willing to update your project files.
+
 ## GUI Tools
 
-To update the tools themselves, you should delete the contents of your `cobra-tools`(1) folder entirely and extract the updated tools ZIP into the same folder. This clears out any old, unused, or cached files that may interfere with tool updates.
+To update the tools themselves, you should delete the contents of your `cobra-tools`(1) folder entirely and extract the newer tools into the same folder. This clears out any old, unused, or cached files that may interfere with tool updates.
 { .annotate }
 
 1. e.g. `cobra-tools-master`
 
 ## Python Dependencies
 
-The tools have an auto updater to handle Python dependency updates for you, which will operate the same as the automatic installer in [Installing Python Dependencies](Download.md#installing-python-dependencies).
+The tools have an auto-updater to handle Python dependency updates for you, which will operate the same as the automatic installer in [Installing Python Dependencies](Download.md#installing-python-dependencies).
 
 ## Blender Plugin
 

diff --git a/docs/index.md b/docs/index.md
@@ -6,5 +6,5 @@
 
 A suite of GUI tools for extracting and modifying OVL and OVS archives, as well as editing the associated in-house file formats. Also includes a model plugin for Blender.
 
-![OVL Tool](assets\images\ovl_tool.png){data-gallery="tools"}
-![Blender Plugin](assets\images\blender_plugin.png){data-gallery="tools"}
+![OVL Tool](./assets/images/ovl_tool.png){data-gallery="tools"}
+![Blender Plugin](./assets/images/blender_plugin.png){data-gallery="tools"}
diff --git a/version.txt b/version.txt
@@ -1 +1 @@
-57e17e1eb - Sun Mar 24 09:12:59 2024 -0400
+fea3d83e7 - Tue Mar 26 04:24:13 2024 -0400
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		57e17e1eb - Sun Mar 24 09:12:59 2024 -0400
		fea3d83e7 - Tue Mar 26 04:24:13 2024 -0400