From 093b2c2df43c5242fb43b2e9bde565fac01f5a5c Mon Sep 17 00:00:00 2001 From: jaseg Date: Tue, 29 Dec 2020 19:50:28 +0100 Subject: Update README --- README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.rst') 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/ -- cgit