summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorjaseg <git@jaseg.net>2020-12-29 19:50:28 +0100
committerjaseg <git@jaseg.net>2020-12-29 19:51:29 +0100
commit093b2c2df43c5242fb43b2e9bde565fac01f5a5c (patch)
treef52f27403f347db69b0e276137fd7f28e60b9169 /README.rst
parent61c0ecea7d1e1ca739b8016844f0db53ec2e125f (diff)
downloadkimesh-093b2c2df43c5242fb43b2e9bde565fac01f5a5c.tar.gz
kimesh-093b2c2df43c5242fb43b2e9bde565fac01f5a5c.tar.bz2
kimesh-093b2c2df43c5242fb43b2e9bde565fac01f5a5c.zip
Update README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
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/