diff --git a/README.rst b/README.rst index 78db5ac..f00d9f8 100644 --- a/README.rst +++ b/README.rst @@ -1,2 +1,21 @@ KiCAD Security Mesh Generator ============================= + +.. image:: kicad-mesh-result-large.png + :width: 800 + :alt: A screenshot of KiCAD showing a PCB security mesh generated by KiMesh. + +This repository contains KiMesh, a KiCAD pcbnew plugin that generates security mesh traces on a KiCAD PCB. + +Installation +------------ +To install, copy the "kimesh" directory into your KiCAD installation's scripting plugin folder. Usually, this is +`~/.config/kicad/scripting/plugins/` for KiCAD stable installations or `~/.config/kicad/5.99/scripting/plugins/` for +nightly builds. On Windows, these paths can be found in your user account's `AppData/Roaming` directory. + +Theory of operation +------------------- + +I have published a post_ on my blog on the theory of operation behind KiMesh. + +.. _post: https://blog.jaseg.de/posts/kicad-mesh-plugin/ diff --git a/kicad-mesh-result-large.png b/kicad-mesh-result-large.png new file mode 100644 index 0000000..798287b Binary files /dev/null and b/kicad-mesh-result-large.png differ diff --git a/plugin/__init__.py b/kimesh/__init__.py similarity index 100% rename from plugin/__init__.py rename to kimesh/__init__.py diff --git a/plugin/debug_install.sh b/kimesh/debug_install.sh similarity index 100% rename from plugin/debug_install.sh rename to kimesh/debug_install.sh diff --git a/plugin/main_dialog.fbp b/kimesh/main_dialog.fbp similarity index 100% rename from plugin/main_dialog.fbp rename to kimesh/main_dialog.fbp diff --git a/plugin/mesh_dialog.py b/kimesh/mesh_dialog.py similarity index 100% rename from plugin/mesh_dialog.py rename to kimesh/mesh_dialog.py diff --git a/plugin/mesh_plugin.py b/kimesh/mesh_plugin.py similarity index 100% rename from plugin/mesh_plugin.py rename to kimesh/mesh_plugin.py diff --git a/plugin/mesh_plugin_dialog.py b/kimesh/mesh_plugin_dialog.py similarity index 100% rename from plugin/mesh_plugin_dialog.py rename to kimesh/mesh_plugin_dialog.py diff --git a/plugin/mesh_plugin_icon.png b/kimesh/mesh_plugin_icon.png similarity index 100% rename from plugin/mesh_plugin_icon.png rename to kimesh/mesh_plugin_icon.png diff --git a/plugin/mesh_plugin_icon.svg b/kimesh/mesh_plugin_icon.svg similarity index 100% rename from plugin/mesh_plugin_icon.svg rename to kimesh/mesh_plugin_icon.svg