refdes_renum: warn of possible number clash with non-conforming values
[geda-gaf/whiteaudio.git] / docs / wiki / start.html
blobb68edadbcc7d4e11c8c9f65e93b4b31096ccb173
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html>
4 <head>
5 <title></title>
6 <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
7 <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
8 <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 </head>
12 <body>
15 <h1 class="sectionedit1582"><a name="geda_project_wiki" id="geda_project_wiki">gEDA Project Wiki</a></h1>
16 <div class="level1">
18 </div>
19 <!-- EDIT1582 SECTION "gEDA Project Wiki" [2-34] -->
20 <h2 class="sectionedit1583"><a name="what_is_geda" id="what_is_geda">What is gEDA?</a></h2>
21 <div class="level2">
23 <p>
25 The <a href="http://www.gpleda.org" class="urlextern" title="http://www.gpleda.org" rel="nofollow">gEDA project</a> is developing a full <acronym title="GNU General Public License">GPL</acronym>&#039;d suite and toolkit of Electronic Design Automation tools. These tools are used for electrical circuit design, schematic capture, simulation, prototyping, and production. Currently, the gEDA project offers a mature suite of free software applications for electronics design, including schematic capture, attribute management, bill of materials (BOM) generation, netlisting into over 20 netlist formats, analog and digital simulation, and printed circuit board (PCB) layout.
26 </p>
28 <p>
29 The tools involved in the suite enable you to professional-quality design of low- to mid-level complexity. Using the gEDA tools, you can create PCB of up to 8 layers (soon more) with an unlimited number of components and nets. The tools are suitable for use by students, educators, hobbyists, consultants, small businesses, and even in large corporations where an engineer might need to crank out a quick PC board (e.g. for a test stand) in a hurry.
30 </p>
32 <p>
33 All of the software in the gEDA suite can be found on the <a href="geda-download.html" class="wikilink1" title="geda-download.html">download</a> page.
34 </p>
36 </div>
37 <!-- EDIT1583 SECTION "What is gEDA?" [35-1144] -->
38 <h2 class="sectionedit1584"><a name="official_project_documentation" id="official_project_documentation">Official Project documentation</a></h2>
39 <div class="level2">
41 <p>
42 These are the official project docs. They have been converted from LaTeX and <acronym title="HyperText Markup Language">HTML</acronym> documents into Wiki pages so that the gEDA community may more easily maintain them.
44 </p>
45 <ul>
46 <li class="level1"><div class="li"> <a href="geda-documentation.html" class="wikilink1" title="geda-documentation.html">Documentation</a> : Contains links to tutorials, manuals, HOWTOs and format specifications of the gEDA suite. </div>
47 </li>
48 </ul>
50 </div>
51 <!-- EDIT1584 SECTION "Official Project documentation" [1145-1484] -->
52 <h2 class="sectionedit1585"><a name="faqs_quick_reference" id="faqs_quick_reference">FAQs &amp; Quick Reference</a></h2>
53 <div class="level2">
55 <p>
56 These are informal FAQs, HOWTOs, and tips/tricks to help you with the practical details of using the gEDA Suite. If you are having a problem, browse these pages first.
58 </p>
59 <ul>
60 <li class="level1"><div class="li"> <a href="geda-faq.html" class="wikilink1" title="geda-faq.html">FAQ</a> : Frequently Asked Questions about the gEDA project itself.</div>
61 </li>
62 <li class="level1"><div class="li"> <a href="geda-installation.html" class="wikilink1" title="geda-installation.html">Installation</a> : gEDA installation HOWTO and <acronym title="Frequently Asked Questions">FAQ</acronym>.</div>
63 </li>
64 <li class="level1"><div class="li"> <a href="geda-glossary.html" class="wikilink1" title="geda-glossary.html">Glossary</a> : Glossary of terms that are specific to the gEDA Suite.</div>
65 </li>
66 <li class="level1"><div class="li"> <a href="geda-usage.html" class="wikilink1" title="geda-usage.html">Usage</a> : Questions about how to do electronic design using the gEDA toolset – information which applies to several or all tools in the gEDA Suite.</div>
67 </li>
68 <li class="level1"><div class="li"> <a href="geda-howto_report_bugs.html" class="wikilink1" title="geda-howto_report_bugs.html">Howto report bugs</a></div>
69 </li>
70 <li class="level1"><div class="li"> <a href="geda-faq-gschem.html" class="wikilink1" title="geda-faq-gschem.html">FAQ-gschem</a> : Questions about installing, configuring, and using gschem. Also, questions about creating and using gschem symbols.</div>
71 </li>
72 <li class="level1"><div class="li"> <a href="geda-faq-attribs.html" class="wikilink1" title="geda-faq-attribs.html">FAQ-attribs</a> : Dealing with BOMs, DRCs, attribute management, and all that.</div>
73 </li>
74 <li class="level1"><div class="li"> <a href="geda-faq-gnetlist.html" class="wikilink1" title="geda-faq-gnetlist.html">FAQ-gnetlist</a> : Questions about installing, configuring, and using gnetlist.</div>
75 </li>
76 <li class="level1"><div class="li"> <a href="geda-faq-simulation.html" class="wikilink1" title="geda-faq-simulation.html">FAQ-simulation</a> : Questions about simulating your design using gEDA tools.</div>
77 </li>
78 <li class="level1"><div class="li"> <a href="geda-faq-gsch2pcb.html" class="wikilink1" title="geda-faq-gsch2pcb.html">FAQ-gsch2pcb</a> : How to take your design to layout using PCB.</div>
79 </li>
80 <li class="level1"><div class="li"> <a href="geda-pcb-quick_reference.html" class="wikilink1" title="geda-pcb-quick_reference.html">PCB-quick reference</a> : PCB Quick Reference Sheet.</div>
81 </li>
82 <li class="level1"><div class="li"> <a href="geda-pcb_footprints.html" class="wikilink1" title="geda-pcb_footprints.html">PCB footprints</a> : How to create, use and share footprints.</div>
83 </li>
84 <li class="level1"><div class="li"> <a href="geda-pcb_tips.html" class="wikilink1" title="geda-pcb_tips.html">PCB tips</a> : Tips and tricks for using PCB.</div>
85 </li>
86 <li class="level1"><div class="li"> <a href="geda-faq-pcb.html" class="wikilink1" title="geda-faq-pcb.html">FAQ-pcb</a> : Questions about the printed circuit board tool “pcb”.</div>
87 </li>
88 <li class="level1"><div class="li"> <a href="geda-gschem_symbol_creation.html" class="wikilink1" title="geda-gschem_symbol_creation.html">gschem Symbol Creation</a> : gschem symbol creation guide.</div>
89 </li>
90 <li class="level1"><div class="li"> <a href="geda-guile_scripting.html" class="wikilink1" title="geda-guile_scripting.html">Guile scripting</a> : Guile functions &amp; variables provided by the gEDA tools.</div>
91 </li>
92 </ul>
94 </div>
95 <!-- EDIT1585 SECTION "FAQs & Quick Reference" [1485-3037] -->
96 <h2 class="sectionedit1586"><a name="developer_documentation" id="developer_documentation">Developer Documentation</a></h2>
97 <div class="level2">
99 <p>
100 The following pages are related to the day-to-day development of the gEDA suite:
102 </p>
103 <ul>
104 <li class="level1"><div class="li"> <a href="geda-developer.html" class="wikilink1" title="geda-developer.html"> developer </a> : Code repository, developer mailing list and building information.</div>
105 </li>
106 <li class="level1"><div class="li"> <a href="geda-todos.html" class="wikilink1" title="geda-todos.html">Todos</a> : Lists of pending project enhancements and todos.</div>
107 </li>
108 <li class="level1"><div class="li"> <a href="geda-tasks.html" class="wikilink1" title="geda-tasks.html">Tasks</a> : Top-level list of jobs/tasks that need help.</div>
109 </li>
110 <li class="level1"><div class="li"> <a href="geda-scm.html" class="wikilink1" title="geda-scm.html">SCM</a> : Information on gEDA/gaf&#039;s source control management (SCM) system and process.</div>
111 </li>
112 <li class="level1"><div class="li"> <a href="geda-release_engineering.html" class="wikilink1" title="geda-release_engineering.html">Release Engineering</a> : Description of various Release Engineering procedures.</div>
113 </li>
114 <li class="level1"><div class="li"> <a href="geda-devel-tips.html" class="wikilink1" title="geda-devel-tips.html">devel-tips</a> : Various tips and tricks when doing gEDA development.</div>
115 </li>
116 </ul>
120 The following pages are work-in-progress discussions and/or brainstorming:
122 </p>
123 <ul>
124 <li class="level1"><div class="li"> <a href="libgeda3.html" class="wikilink1" title="libgeda3.html">libgeda3</a> : Discussion of <acronym title="Application Programming Interface">API</acronym> and design for a next generation libgeda.</div>
125 </li>
126 <li class="level1"><div class="li"> <a href="geda-circuit_simulation_improvements.html" class="wikilink1" title="geda-circuit_simulation_improvements.html">Circuit Simulation Improvements</a> : Discussion on how to better integrate circuit simulations, gschem and gnetlist.</div>
127 </li>
128 <li class="level1"><div class="li"> <a href="geda-data_plotting_improvements.html" class="wikilink1" title="geda-data_plotting_improvements.html">Data Plotting Improvements</a> : Discussion on how to better plot simulation data.</div>
129 </li>
130 <li class="level1"><div class="li"> <a href="geda-design_flow_and_hierarchy_roadmap.html" class="wikilink1" title="geda-design_flow_and_hierarchy_roadmap.html">Design Flow and Hierarchy Roadmap</a> : Discussion of wants for circuit design, reusing modules in a hierarchy.</div>
131 </li>
132 <li class="level1"><div class="li"> <a href="geda-pcb_funding_sow.html" class="wikilink1" title="geda-pcb_funding_sow.html"> PCB Funding SOW</a> : An SOW specifying improvements to PCB performed within a funding program.</div>
133 </li>
134 <li class="level1"><div class="li"> <a href="geda-format_translation.html" class="wikilink1" title="geda-format_translation.html">format translation</a> : Some notes on file format translation.</div>
135 </li>
136 <li class="level1"><div class="li"> <a href="geda-gparts_tc.html" class="wikilink1" title="geda-gparts_tc.html">Parts Manager</a> : A working document for a gEDA parts manager</div>
137 </li>
138 </ul>
140 </div>
141 <!-- EDIT1586 SECTION "Developer Documentation" [3038-4443] -->
142 <h2 class="sectionedit1587"><a name="talks" id="talks">Talks</a></h2>
143 <div class="level2">
146 These are slides of presentations done about gEDA. They provide a good top-level overview of the project for those who are interested.
148 </p>
149 <ul>
150 <li class="level1"><div class="li"> <a href="http://geda.seul.org/talks/" class="urlextern" title="http://geda.seul.org/talks/" rel="nofollow">talks</a>: Various talks and presentations on gEDA </div>
151 </li>
152 </ul>
154 </div>
155 <!-- EDIT1587 SECTION "Talks" [4444-4686] -->
156 <h2 class="sectionedit1588"><a name="google_summer_of_code" id="google_summer_of_code">Google Summer of Code</a></h2>
157 <div class="level2">
161 The gEDA project has participated in the Google Summer of Code.
162 </p>
165 Here are archived instructions and ideas from previous years:
167 </p>
168 <ul>
169 <li class="level1"><div class="li"> <a href="gsoc2007.html" class="wikilink1" title="gsoc2007.html">2007</a></div>
170 </li>
171 <li class="level1"><div class="li"> <a href="gsoc2008.html" class="wikilink1" title="gsoc2008.html">2008</a></div>
172 </li>
173 <li class="level1"><div class="li"> <a href="gsoc2009.html" class="wikilink1" title="gsoc2009.html">2009</a> (gEDA did not participate in 2009)</div>
174 </li>
175 <li class="level1"><div class="li"> <a href="gsoc2010.html" class="wikilink1" title="gsoc2010.html">2010</a> (gEDA did not participate in 2010)</div>
176 </li>
177 </ul>
179 </div>
180 <!-- EDIT1588 SECTION "Google Summer of Code" [4687-5015] -->
181 <h2 class="sectionedit1589"><a name="translations" id="translations">Translations</a></h2>
182 <div class="level2">
183 <ul>
184 <li class="level1"><div class="li"> En français, cela débute <a href="start_fr.html" class="wikilink1" title="start_fr.html">ici</a>.</div>
185 </li>
186 <li class="level1"><div class="li"> Spanish language <a href="start_es.html" class="wikilink1" title="start_es.html">links</a></div>
187 </li>
188 </ul>
190 </div>
191 <!-- EDIT1589 SECTION "Translations" [5016-5133] -->
192 <h2 class="sectionedit1590"><a name="geda_users" id="geda_users">gEDA Users</a></h2>
193 <div class="level2">
196 Users may discuss development, help, installation, and working tips through the <a href="geda-mailinglists.html" class="wikilink1" title="geda-mailinglists.html">mailinglists</a>.
197 </p>
200 There is also a gEDA <acronym title="Internet Relay Chat">IRC</acronym> channel at <strong>irc.seul.org/6667</strong> on the <strong>#geda</strong> channel. Sometimes this channel is full of activity and sometimes it is quite silent. Please be patient when asking questions in the <acronym title="Internet Relay Chat">IRC</acronym> channel.
201 </p>
204 The so-called “Free Dog” organization ( <a href="http://freeedaug.org/" class="urlextern" title="http://freeedaug.org/" rel="nofollow">Freeedaug</a> ) meets in the Boston area and discusses gEDA and related topics.
205 </p>
207 </div>
208 <!-- EDIT1590 SECTION "gEDA Users" [5134-5632] -->
209 <h2 class="sectionedit1591"><a name="about_this_wiki" id="about_this_wiki">About this Wiki</a></h2>
210 <div class="level2">
213 This section of the gEDA website is dedicated to documentation that is contributed by a multitude of authors, including users. In particular, it should grow into a resource of information for those who just started to work with the tools.
214 </p>
217 Anyone is welcome to contribute. Unlike Wikipedia there is no button to create a login by yourself. This is because nobody at the gEDA site has the nerves to deal with anonymous vandalism. Consequently, you have to write an email to the site admin (ahvezda AT geda.seul.org) to gain access. He will gladly send you a login.
219 </p>
221 </div>
222 <!-- EDIT1591 SECTION "About this Wiki" [5633-] --></body>
223 </html>