Clean up of the repository

LocalRemesherAddon/ParticleRemesher.py

@@ -286,7 +286,7 @@ def execute(self, context):
         # recalculate normals
         bmesh.ops.recalc_face_normals(bm, faces=selected_faces)
 
-        # project vertices to original mesh uing interpolation
+        # project vertices to original mesh
         vertices = [vert for vert in bm.verts if vert.select]
         projection_tree = preprate_bm_for_projection(bm_proj2, subdiv=1, delete_faces=False)
         for vert in vertices:
@@ -306,10 +306,6 @@ def execute(self, context):
                         break
                 face.select = selected
 
-        # look at pairs of quads and potentially change the splitting line
-        vertices = [vert for vert in bm.verts if vert.select and vert.is_valid]
-        improve_edge_flow_direction(bm, vertices, avg_direction)
-
         # update bmesh
         bm.to_mesh(me)
         bm.free()

README.md

@@ -1,2 +1,27 @@
 # LocalRemesher
+
 Blender addon for remeshing selected area with awarness of surrounding geometry.
+
+## Installation
+
+- Download the latest release
+- Open Blender
+- Go to `Edit > Preferences > Add-ons > Install...`
+- Select the downloaded file
+- Enable the addon
+
+## Usage
+
+- Select an object and enter edit mode
+- Select an area you want to remesh
+- Navigate to right panel in 3D view, find `Local Remesher` tab
+- Click one of the buttons to remesh the selected area
+
+## Tips
+
+The addon is not yet perfect, so here are some tips to get better results:
+- Try to select a single closed area of convex shape
+- Surrounding geometry should contain good topology
+- If the result is not good, try selecting a smaller or larger area
+- Particle-based method is better for smaller areas
+- Grid-based method is better for a little larger areas