summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorsaurabhb172020-02-26 16:11:59 +0530
committerGitHub2020-02-26 16:11:59 +0530
commite255d0622297488c1c52755be670733418c994cf (patch)
tree1392c90227aeea231c1d86371131e04c40382918 /README.txt
parent0db48f6533517ecebfd9f0693f89deca28408b76 (diff)
parentc38609295ad4b617aef472b9c575aee18710a50f (diff)
downloadKiCad-eSim-e255d0622297488c1c52755be670733418c994cf.tar.gz
KiCad-eSim-e255d0622297488c1c52755be670733418c994cf.tar.bz2
KiCad-eSim-e255d0622297488c1c52755be670733418c994cf.zip
Merge pull request #1 from saurabhb17/develop
Secondary files
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5a7fe27
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,41 @@
+KiCad README
+============
+For specific documentation like Compiling, GUI translation, Old changelogs see the
+Documentation subfolder.
+
+Files
+-----
+AUTHORS.txt - The authors, contributors, document writers and translators list
+CHANGELOG.txt - This years changelog (see for previous years Documentation/changelogs)
+CMakeList.txt - CMAKE build tool script
+COPYRIGHT.txt - A copy of the GNU General Public License Version 2
+CTestConfig.cmake - Support for CTest and CDash testing tools
+Doxyfile - Doxygen config file for Kicad
+INSTALL.txt - The release (binairy) installation instructions
+TODO.txt - Todo list
+uncrustify.cfg - Uncrustify config file for uncrustify sorces formatting tool
+
+Subdirectories
+--------------
+3d-viewer - Sourcecode of 3D viewer
+bitmaps - Menu and program icons
+bitmap2component - Sourcecode of a small application to create a footprint or a component from a B&W bitmap
+ this component or footprint has just graphic items that show the bitmap
+CMakeModules - Modules for the CMAKE build tool
+common - Sourcecode of the common library (common functions shared across whole suite)
+cvpcb - Sourcecode of CvPCB, tool to link components with footprints sourcecode
+demos - Some demo examples
+Documentation - Compiling documentation. Translating the GUI, old changelogs etcetera.
+eeschema - Sourcecode of the schematic editor
+gerbview - Sourcecode of the gerber viewer
+helpers - Helper tools and utilities for development
+include - Interfaces to the common library
+internat - Internationalisation files
+kicad - Sourcecode of the project manager
+packaging - Files for packaging on Windows and Mac OSX
+pcbnew - Sourcecode of the printed circuit board editor
+polygon - Sourcecode of the polygon library
+resources - Resources for installation, freedesktop mime-types for linux
+scripts - Helper scripts. For building, sourcecode packaging.
+template - Project template(s)
+