Skip to content
Newer
Older
100644 134 lines (87 sloc) 4.47 KB
3439567 @avian2 Added README, license.
authored
1 Eagle automation
2 ================
3
19ada4b @avian2 Updated README.
authored
4 Eagle automation provides a more Unix-like and scriptable interface to the
5 CadSoft Eagle electronics design package. It is meant to make open hardware
6 development a bit more convenient for anyone that is used to the procedures
7 usually employed by open source software projects (for example using source
8 control tools and one-step builds).
3439567 @avian2 Added README, license.
authored
9
41ce9ef @avian2 Link to Guyzmo's fork in the README.
authored
10 Note these scripts have only been tested using Eagle 5.11.0. If you are using a
11 newer version of Eagle, you might want to try Guyzmo's largely refactored and
12 updated fork at https://github.com/guyzmo/eagle-automation
13
19ada4b @avian2 Updated README.
authored
14 This repository currently contains the following:
3439567 @avian2 Added README, license.
authored
15
1f20178 @avian2 Implement basic diff for libraries.
authored
16 eaglediff - Commandline diff tool for schematics, board layouts and
17 libraries that is compatible with git-difftool.
18
19 For schematics and board layouts, a visual diff is
20 displayed.
21
aee2032 @avian2 Spelling
authored
22 For libraries, a textual comparison of library elements is
1f20178 @avian2 Implement basic diff for libraries.
authored
23 shown.
3439567 @avian2 Added README, license.
authored
24
19ada4b @avian2 Updated README.
authored
25 eagleexport - A tool that exposes a unified commandline interface to various
26 different ways Eagle offers for exporting artwork.
27
28 It currently supports exporting Eagle files to Gerber, PDF and
29 PNG formats, generating Excellon drill files and files needed
30 for pick & place machines.
31
32 eagledrl - Generate .drl files from .dri without any annoying dialogs.
33
34 skel/Makefile - An example Makefile that demonstrates how fabrication and
35 assembly documentation for a project can be generated
36 automatically with GNU Make.
3439567 @avian2 Added README, license.
authored
37
38
39
40 Installation
41 ============
42
43 Run:
44
45 $ python setup.py install
46 $ git config --global --add difftool.eaglediff.cmd 'eaglediff $LOCAL $REMOTE'
47
48
49
50 Usage
51 =====
52
53 You can find a Makefile in the skel/ subdirectory that shows how you can
54 automatically build your project's documentation using make from .sch and
55 .brd files.
56
57 To show differences to the design that have not yet been committed:
58
59 $ git difftool -t eaglediff
60
61 To show differences between two tagged versions:
62
63 $ git difftool -t eaglediff v1.0..v2.0
64
65 Note that Eagle windows will blink on and off during the use of these
66 tools. Try not to touch anything while they are doing that.
67
68 Also, Eagle sometimes behaves weirdly if more than one instance of it is
69 running: it might occasionally stop in the middle of a script or throw a
70 random error dialog. Because of the closed nature of this software there is
71 nothing that can be done about that. If that bothers you, consider
72 switching to a free EDA tool.
73
74
75
0de95c8 @avian2 Update documentation.
authored
76 Configuration
77 =============
78
79 These tools make a distinction between "export layers" (e.g. layer names
80 used on the eagleexport command line) and "Eagle layers" (layer names as they
81 appear in the Eagle user interface). One export layer typically corresponds to
82 one mask and consists of one or more Eagle layers.
83
84 For example "topcopper" export layer by default includes "Top", "Pads" and
85 "Vias" Eagle layers.
86
87 A configuration file provides a mapping between export layers and Eagle layers
88 and some other tweakable settings. Default configuration is installed by
89 setup.py. It should work for most simple one- or two-layer boards.
90
91 Should you want to adjust something, you can place your own configuration file
92 to one of the following locations. Settings in later locations override earlier
93 ones:
94
95 /etc/eagle_automation.conf
96 $HOME/.config/eagle_automation.conf
97 ./eagle_automation.conf
98
99 You can use the 'eagle_automation/default.conf' file as a template.
100
101
102
585d504 @avian2 Adding "known problems" section.
authored
103 Known problems
104 ==============
105
106 When exporting to PDF using eagleexport, default print settings are used.
107 To set them, go to File -> Print setup, make changes, then quit Eagle so
108 that the settings are saved.
109
93e2304 @avian2 Add --page option to eaglediff.
authored
110 Exporting and diffing multi-page schematics doesn't work well. Only one page
111 can be compared at a time and you have to specify the page number on the
112 command line using --page.
585d504 @avian2 Adding "known problems" section.
authored
113
114
115
3439567 @avian2 Added README, license.
authored
116 License
117 =======
118
119 Eagle automation, set of commandline tools for use with CadSoft Eagle
0de95c8 @avian2 Update documentation.
authored
120 Copyright (C) 2014 Tomaz Solc <tomaz.solc@tablix.org>
3439567 @avian2 Added README, license.
authored
121
122 This program is free software: you can redistribute it and/or modify
123 it under the terms of the GNU General Public License as published by
124 the Free Software Foundation, either version 3 of the License, or
125 (at your option) any later version.
126
127 This program is distributed in the hope that it will be useful,
128 but WITHOUT ANY WARRANTY; without even the implied warranty of
129 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
130 GNU General Public License for more details.
131
132 You should have received a copy of the GNU General Public License
133 along with this program. If not, see <http://www.gnu.org/licenses/>.
Something went wrong with that request. Please try again.