summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorWerner Almesberger <werner@almesberger.net>2016-08-04 11:11:36 (GMT)
committerWerner Almesberger <werner@almesberger.net>2016-08-04 11:11:36 (GMT)
commit336f2773486a8902c3c2a9c2b13f8cb4cf265bf0 (patch)
treeb178de2093ee1dca0bcb0b7b92427cbd24a9c899 /README
parente14fbe0149676be0cf01da550386cecc0e245435 (diff)
downloadeeshow-336f2773486a8902c3c2a9c2b13f8cb4cf265bf0.zip
eeshow-336f2773486a8902c3c2a9c2b13f8cb4cf265bf0.tar.gz
eeshow-336f2773486a8902c3c2a9c2b13f8cb4cf265bf0.tar.bz2
eeshow/README, COPYING.GPLv2
Diffstat (limited to 'README')
-rw-r--r--README38
1 files changed, 38 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..7d20465
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+eeshow - Eeschema schematics renderer and viewer
+================================================
+
+Eeshow renders schematics made by KiCad Eeschema to FIG, PDF, or PNG,
+and generates graphical differences between different versions of
+schematics sheets. It can work in plain files but it can also
+retrieve design files directly from a git repository. Furthermore,
+eeshow has an interactive mode for viewing schematics and differences.
+
+This work is distributed under the terms of the GNU GENERAL PUBLIC
+LICENSE, Version 2:
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+For your convenience, a copy of the complete license has been included
+in the file COPYING.GPLv2.
+
+
+Prerequisites
+-------------
+
+libcairo2-dev
+libgit2-dev
+libgtk-3-dev
+
+
+Key functions in GUI mode
+-------------------------
+
++ or = zoom in
+- zoom out
+* zoom to extents
+Home go to the top sheet
+Delete or Backspace go to the previous sheet
+Q quit the viewer