screenshot / readme

configure_tool.lua

@@ -21,9 +21,7 @@ minetest.register_tool("pick_and_place:configure", {
             pos1[playername] = pointed_pos
         end
     end,
-    on_secondary_use = function(itemstack, player)
-        print("on_secondary_use: " .. itemstack:get_name() .. ", " .. player:get_player_name())
-
+    on_secondary_use = function(_, player)
         local playername = player:get_player_name()
         pos1[playername] = nil
     end,

readme.md

@@ -5,6 +5,37 @@ Pick and place tool for minetest
 * Select and place areas on the fly
 * Configure an area with "handles" to pick and place them quickly
 
+# Screenshots
+
+![Placement tool](./screenshot_place.png)
+
+![Pickup handles](./screenshot_configure.png)
+
+# Howto
+
+## Quick pick-and-place
+
+Simple copy+paste operation
+
+* Use the `pick_and_place:pick` tool to select the area to use
+* First click for first position and second click for the second position
+* This will convert the pick-tool to a `pick_and_place:place` tool in your inventory
+* Use the place-tool to place your build anywhere in the world with the help of the preview-overlay
+
+## Configure a template area
+
+Create a template for frequent reuse
+
+* Use the `pick_and_place:configure` tool to select an area for your template
+* First click for first position and second click for the second position
+* This will create "handle" nodes on every corner of the build
+* Right-click the corners to create a placement-tool for the template
+* Place as needed
+
+# Limitations
+
+The schematic data is stored in the tool and may not scale well beyond a certain size
+
 # Licenses
 
 * Code: `MIT`