From a8918a9fce4d10da39475fa88eaafb1027752aec Mon Sep 17 00:00:00 2001
From: Kitbashery <70074784+kitbashery@users.noreply.github.com>
Date: Thu, 15 Oct 2020 14:54:10 -0700
Subject: [PATCH] Update README.md
---
README.md | 40 +++++++++++++++++++++++++++++++++++++++-
1 file changed, 39 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 3844966..0c95ea0 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
# Kitbashery-Improved-Mesh-Combiner
-An improved mesh combiner developed for Kitbashery. Combiner welds vertices and packs UVs.
+An improved mesh combiner developed for Kitbashery. This contains an alternative implementation of Unity's built-in mesh combiner.
+
+
+
License:
+Created by Jorge Reyna Tamez @ https://www.fiverr.com/wkepro
+
+Maintained by Kitbashery @ https://www.kitbashery.com
+
+
+Features:
+This project contains an imporved mesh combiner for use in Kitbashery it does the following:
+
+
+ - Combines Meshes into a single mesh.
+ - (optionally) Merges vertices into vertex welds.
+ - Packs UVs so they don't overlap or stretch
+
+
+
+This does NOT do the following (Kitbashery doesn't need these features):
+
+
+ - Pack textures.
+ - Combine submeshes.
+ - Combine skinned meshes.
+ - Preserve vertex colors.
+
+
+Usage:
+
+1) Import the .unitypackage file found under releases.
+
+2) Editor implementation can be found under Tools>Kitbashery Combine Meshes>
+
+Testing:
+Kitbashery contains a modified version of https://github.com/Chaser324/unity-wireframe" (required dependancy) wireframe shader that has been modified to display the wireframe of UVs in worldspace grab it from here:
+https://github.com/kitbashery/Kitbashery/blob/Latest-Experimental/Assets/_Kitbashery/Shaders/UVWireframeShaded-Unlit.shader"
+
+Note: Unity's default quad will always be a perfect UV square and represent UV bound in worldspace. Also note that all UVs are offset by 0.5f in X and Y direction when visualized.