From d2121f1d6f1fcf8eddb3609da6bbee856a6f8d65 Mon Sep 17 00:00:00 2001
From: Fredrik Thulin <fredrik@thulin.net>
Date: Tue, 26 Sep 2017 10:48:14 +0200
Subject: more documentation

---
 .gitignore | 4 ++++
 README.md  | 4 ++++
 convert.sh | 8 ++++++++
 3 files changed, 16 insertions(+)

diff --git a/.gitignore b/.gitignore
index ac1bb7f..9513739 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,7 @@
 rev03-Altium
 git-init.sh
 altium2kicad
+hardware
+rev03-KiCad/Cryptech Alpha.kicad_pcb.*
+.idea
+rev03-KiCad/wrlshp
diff --git a/README.md b/README.md
index a89ccd8..d077b02 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,10 @@ and the altium2kicad project from
 
 Current status
 --------------
+NOTE: The latest stable KiCAD version as of this writing is 4.0.7 - it does
+NOT include necessary support for stitching vias. Install KiCAD nightly build
+to work with the Cryptech Alpha PCB.
+
 The schematics are successfully converted.
 
 All the copper layers convert reasonably well. The challenges are mostly
diff --git a/convert.sh b/convert.sh
index 904912b..2d52612 100755
--- a/convert.sh
+++ b/convert.sh
@@ -27,8 +27,15 @@ cd ${altiumdir}
 rename 's/rev02_/rev02_0/' rev02_?.*
 
 ../altium2kicad/unpack.pl
+# Create WRL files using FreeCAD, unless wrl-files.tar.gz already exists
+# (and I've checked that file into the repository so that you do not have
+# to install FreeCAD).
+# Something is not 100% working in the step2wrl.FCMacro file, so you have
+# to close all the FreeCAD windows that are opened after they finish executing
+# the macro.
 test -f ../wrl-files.tar.gz || ../make-wrl-files.sh
 tar zxf ../wrl-files.tar.gz
+
 time ../altium2kicad/convertschema.pl
 time ../altium2kicad/convertpcb.pl
 
@@ -40,6 +47,7 @@ cp ${altiumdir}/*.{sch,lib} "${kicaddir}"/
 rm ${kicaddir}/rev02*-cache.lib
 cp ${altiumdir}/CrypTech-PcbDoc.kicad_pcb "${kicaddir}/Cryptech Alpha.kicad_pcb"
 cp -rp ${altiumdir}/wrlshp ${kicaddir}/wrlshp
+# Install prepared KiCAD project file and top-level schematic sheet.
 cp "Cryptech Alpha.pro.template" "${kicaddir}/Cryptech Alpha.pro"
 cp "Cryptech Alpha.sch.template" "${kicaddir}/Cryptech Alpha.sch"
 
-- 
cgit v1.2.3