From 6767ea7bbf712d0fd7e1ab540d19320d4ce90372 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nick=20=C3=98stergaard?= Date: Sat, 3 Sep 2016 14:19:50 +0200 Subject: [PATCH] Update the REAMDE.txt to reflect the current structure The old changelog was archived together with the others in Documentation/changelogs. --- .../changelogs/CHANGELOG-2012.txt | 0 README.txt | 70 ++++++++++--------- 2 files changed, 38 insertions(+), 32 deletions(-) rename CHANGELOG.txt => Documentation/changelogs/CHANGELOG-2012.txt (100%) diff --git a/CHANGELOG.txt b/Documentation/changelogs/CHANGELOG-2012.txt similarity index 100% rename from CHANGELOG.txt rename to Documentation/changelogs/CHANGELOG-2012.txt diff --git a/README.txt b/README.txt index ab05f7562e..f88872e2be 100644 --- a/README.txt +++ b/README.txt @@ -1,41 +1,47 @@ KiCad README ============ -For specific documentation like Compiling, GUI translation, Old changelogs see the -Documentation subfolder. +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 (binary) installation instructions -TODO.txt - Todo list -uncrustify.cfg - Uncrustify config file for uncrustify sources formatting tool +AUTHORS.txt - The authors, contributors, document writers and translators list +CMakeList.txt - Main 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 (binary) installation instructions +TODO.txt - Todo list (looks outdated) +uncrustify.cfg - Uncrustify config file for uncrustify sources 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) +3d-viewer - Sourcecode of the 3D viewer +bitmap2component - Sourcecode of the bitmap to pcb artwork converter +bitmaps_png - Menu and program icons +CMakeModules - Modules for the CMAKE build tool +common - Sourcecode of the common library +cvpcb - Sourcecode of the CvPCB tool +demos - Some demo examples +Documentation - Developer documentation. 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 +kicad - Sourcecode of the project manager +lib_dxf - Sourcecode of the polygon library +new - Staging area for the new schematic library format +pagelayout_editor - Sourcecode of the pagelayout editor +patches - Collection of patches for external dependencies +pcbnew - Sourcecode of the printed circuit board editor +plugins - Sourcecode of the new plugin concept +polygon - Sourcecode of the polygon library +potrace - Sourcecode of the potrace library +qa - Testcases using the python interface +resources - Resources for freedesktop mime-types for linux +scripting - SWIG Python scripting definitions +scripts - Helper scripts for various things +template - Project and pagelayout templates +tools - Other miscellaneous helpers for testing +utils - Small utils for kicad, e.g. IDF tools