2016-09-15 20:33 GMT+02:00 Wayne Stambaugh <stambau...@gmail.com>:
> On 9/15/2016 1:39 PM, Nick Østergaard wrote:
>> Hi
>>
>> I was going to submit a patch to update the short description for the
>> various folders in the the root of the kicad source repo, but I am a
>> bit confused to what to write for the "new" folder.
>>
>> My best suggestion for it was something like "Old crap (not built)" or
>> Draft for undocumented SWEET concept. Those descriptions are not
>> really helpfull at all.
>
> Sweet is the eeschema analog to pcbnew's pretty.  It's just the name
> given to the new component library file format.  Once sweet is
> implemented KiCad will be pretty sweet.  Yes, it's silly.  But what's
> life without a little whimsy.
>

I see. Attached is my proposal for a more up to date overview.

Please note the TODO.txt description. Maybe it should just be removed,
and possibly be moved to the doxygen devdocs if it is supposed to
exist.

Also, it seems that the helpers and tools dir have sort of similar purpose.

>>
>> What is the use of this folder? As far as I can see nothing in there
>> is built. it seems to be a stashing place for something called SWEET.
>>
>> Is this a eeschema pendant to pcbnew's pretties?
>> Is the new folder to be deleted or kept for future reference?
>> Is this related to Wayne's eeschema refactoring?
>
> Possibly, that's why it's been kept around.  Once the new schematic and
> file formats are completed, I will remove the new/ folder.
>

Ok.

>>
>> Nick
>>
>> _______________________________________________
>> Mailing list: https://launchpad.net/~kicad-developers
>> Post to     : kicad-developers@lists.launchpad.net
>> Unsubscribe : https://launchpad.net/~kicad-developers
>> More help   : https://help.launchpad.net/ListHelp
>>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@lists.launchpad.net
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
From d2f2a9ae8a7290573fd5c08d17c0f250ca7cba80 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nick=20=C3=98stergaard?= <oe.n...@gmail.com>
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 ab05f75..f88872e 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
 
-- 
2.9.3

_______________________________________________
Mailing list: https://launchpad.net/~kicad-developers
Post to     : kicad-developers@lists.launchpad.net
Unsubscribe : https://launchpad.net/~kicad-developers
More help   : https://help.launchpad.net/ListHelp

Reply via email to