Big cleanup of sourcetree root structure, added Documentation subfolder, moved...

Big cleanup of sourcetree root structure, added Documentation subfolder, moved packaging stuff for osx and windows (nsis) to packaging.

CMake.TODO

-TODO:
-* Add install targets for binaries and resources on Mac.
-* Add PYTHON.
-* Testing.
-* More testing ...

CMakeLists.txt

@@ -185,7 +185,7 @@ add_subdirectory(template)
 install(FILES INSTALL.txt
         DESTINATION ${KICAD_DOCS}
         COMPONENT resources)
-install(FILES freeroute.jnlp
+install(FILES resources/freeroute.jnlp
         DESTINATION ${KICAD_BIN}
         COMPONENT resources)
 ###

copyright.h → Documentation/copyright.txt

@@ -18,8 +18,8 @@ Thanks, Dick Hollenbeck dick@softplc.com.
 /*
  * This program source code file is part of KICAD, a free EDA CAD application.
  *
- * Copyright (C) 1992-2008 Jean-Pierre Charras, jean-pierre.charras@inpg.fr
- * Copyright (C) 1992-2008 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2009 Jean-Pierre Charras, jean-pierre.charras@inpg.fr
+ * Copyright (C) 1992-2009 Kicad Developers, see AUTHORS.txt for contributors.
  * 
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License

UIpolicies.txt → Documentation/guidelines/UIpolicies.txt

@@ -17,7 +17,7 @@ Dialogs:
     "default buttons", ESC key termination.
     
     Use wxWidgets "sizers" in all dialogs, no matter how simple they are: 
-    http://www.lpthe.jussieu.fr/~zeitlin/wxWindows/docs/wxwin_sizeroverview.html
+    http://zetcode.com/tutorials/wxwidgetstutorial/layoutmanagement
     and keep dialogs resizeable.
     
     Configure the sizers so that as the dialog window is expanded, the most

INSTALL.txt

 KiCad installation
 ==================
 
-   KiCad consists of 3 packages:
+The parts of KiCad
+------------------
+KiCad consists of 3 packages:
 
 kicad         - KiCad programs and core files.
 kicad-doc     - Documentation and interactive help (optional package).
 kicad-library - KiCad schematic, pcb & 3D-model libraries (optional package).
 
+
 Installation from binary packages
-=================================
+---------------------------------
 
    KiCad binary packages exist for Linux and Windows (XP, 2000).
 
@@ -17,8 +20,9 @@ Installation from binary packages
 *.zip  - KiCad packages for Windows.
 *.tbz2 - KiCad for Linux.
 
+
 Installation from binary packages for Windows
-=============================================
+---------------------------------------------
 
    KiCad can be installed in 'C:\kicad', 'D:\kicad', 'C:\Program files\kicad',
 'D:\Program files\kicad'.
@@ -38,8 +42,9 @@ utilities: cvpcb and gerbview).
 
    You can create a shortcut to 'C:\kicad\bin\kicad.exe'.
 
+
 Installation from binary packages for Linux
-===========================================
+-------------------------------------------
 
    KiCad can be installed in '/usr' or '/usr/local'.
 
@@ -52,8 +57,9 @@ Installation from binary packages for Linux
 
    The main program is '/usr/bin/kicad'.
 
-Windows KiCad tree:
-===================
+
+Windows KiCad tree
+------------------
 
 kicad/bin                      - Binaries (executable files).
 kicad/doc                      - Various documentation.
@@ -68,8 +74,9 @@ kicad/share/modules/packages3d - 3D component models (.wrl and .wings format).
 view with pcbnew.
    Files *.brd show the existing modules (and 3D shapes) in libraries.
 
-Linux KiCad tree:
-=================
+
+Linux KiCad tree
+----------------
 
 /usr/bin                            - Binaries (executable files).
 /usr/share/doc/kicad/               - Various documentation.
@@ -95,7 +102,7 @@ libraries, etc.).
 
 
 Installation from source code
-=============================
+-----------------------------
 
    Some dependencies must be satisfied for the correct installation of KiCad:
 
@@ -129,8 +136,9 @@ the Makefiles.
    If you want to uninstall KiCad again type "make uninstall" from within the
 build directory.
 
+
 Important parameters to cmake
-==============================
+-----------------------------
 
 -DCMAKE_BUILD_TYPE=<buildtype>
 <buildtype> may current one of "Debug" and "Release".
@@ -173,8 +181,9 @@ Extra flags for the c++ compiler for your system required.
 -DCMAKE_VERBOSE_MAKEFILE=ON
 When more output is wanted use this cmake parameter or call "make VERBOSE=1".
 
-Extra cflags and linker flags
-=============================
+
+Extra CFLAGS and linker flags
+-----------------------------
 
    If you require extra flags for compiler and linker you may give them via
 environment variables

README.txt

+KiCad README
+============
+
+Please have a look at the other files,
+for specific documentation like Compiling, GUI translation see the Documentation folder.
+
+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
+Doxyfile       - Doxygen preferences
+INSTALL.txt    - The release (binairy) installation instructions
+TODO.txt       - Todo list
+uncrustify.cfg - Uncrustify code formatting tool preferences
+version.txt    - The current stable released version
+
+Subdirectories
+--------------
+3d-viewer      - Sourcecode of 3D viewer
+bitmaps        - Menu and program icons
+CMakeModules   - Modules for the CMAKE build tool
+common         - Sourcecode of the common library (common functions shared across whole suite)
+cvpcb          - Sourcecode of CvPCB, (eeschema) convert to pcb sourcecode
+demos          - Some demo examples
+Documentation  - Misc documentation. Translating the GUI, old changelogs etcetera.
+eeschema       - Sourcecode of the schematic editor
+gerbview       - Sourcecode of the gerber viewer
+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, font setting, pcb adjusting.
+share          - ?
+template       - Project template(s)
+
+
+
+
+
+

TODO.txt

+KiCad TODO List
+===============
+
+CMAKE Todo
+----------
+
+TODO:
+* Add install targets for binaries and resources on Mac.
+* Add PYTHON.
+* Testing.
+* More testing ...
+
+
+
 
 Here are some source code maintenance tasks that need to be done, and maybe some
 folks will see these items and volunteer to do them.
@@ -35,7 +49,7 @@ Need to do this using DialogBlocks.
 
 2009-02-10 08:58 Assigned To:
 asked by: Cfdev (Sourceforge Feature Request)
-===============================================================================
+---------------------------------------------------------------------------
 PCBNEW Unroute function in rightclick menu (for component)
 
 ---Message---

regex_doc.txt

-Regular expression
-Tutorial du 1 mars 2005 - Aurélien Jarno
-I - Significations des métacaractères :
-
-    * \ sert à protéger un caractère, au cas où il aurait une autre interprétation possible.
-      Comme en C, il précède les caractères n, t, ... pour désigner la fin de ligne (\n), une tabulation (\t), etc ..
-
-    * [ ] sert à désigner un ensemble de caractères à reconnaitre:
-          o [fa]oo par exemple recherche les chaines formées par f, ou a, suivi de "oo", soit foo ou bien aoo
-          o [a-z] représente l'ensemble des lettres minuscules
-          o [0-9] représente l'ensemble des chiffres
-          o [^O] le symbole ^ négative l'expression. Donc ici on cherche n'importe quelle lettre, O étant exclus.
-          o [^0-9] recherche n'importe quel caractère autre que numérique.
-          o [:alpha:] représente l'ensemble des caractères alphabétiques, donc [[:alpha:]] est équivalent à [A-Za-z]
-          o [=a=] représente la classe des caractères semblables à a, donc ici les lettres minuscules
-          o [=0=] représente la classe des chiffres
-
-    * +, * et ? servent à exprimer une répétition :
-          o fo+ reconnait la chaine fo suivi de n fois la lettre O, donc foo, fooo, fooo, ...
-          o fo* reconnait les chaines f, fo, fo, ..., c'est à dire que le o est optionnel (de 0 à n fois)
-          o fo? Le ? signifie zéro ou 1 fois, donc reconnait seulement les chaines f et fo
-
-    * {} servent à exprimer une répétition, mais avec plus de précision :
-          o {,3} signifie trois fois au plus
-          o {2,} signifie deux fois au minimum
-          o {2} signifie deux fois et deux fois seulement
-      Exemple : [a-f0-9]{8} cherche tous les chiffres hexadecimaux sur 8 caractères
-
-    * Le caractère . représente n'importe quel caractère, autre que fin de ligne. Il est souvent associé à * pour désigner une succession quelconque de caractères
-
-    * Les parenthèses () servent à grouper un ensemble de caractères tel que (ab) qui signifie "ab" en tant que chaine de caractères et non plus un ensemble de caractères. Avec certains outils, permet en plus de mémoriser l'occurence trouvée, laquelle peut-être réétiliser par la suite dans l'expression sous la forme : \1,\2,...\n. Par exemple : ([au]\1)+ reconnait une séquence de a ou de u comme par exemple "aaaaaa" ou "uuu".
-
-    * Le caractère | sert à établir une alternative : (oo|ba) recherche la chaine "oo" ou bien "ba".
-
-    * ?: se rajoute en début d'une expression entre parenthèses pour ne pas mémoriser : (?:oo|ba)
-
-    * Les caractères ^ et $ repèrent les débuts et fin de ligne.
-
-    * Les raccourcis :
-          o \w représente l'ensemble [A-Za-z]
-          o \W représente l'ensemble [^A-Za-z] (soit la négation du précédent)
-          o \d représente l'ensemble [0-9]
-          o \D représente l'ensemble [^0-9]
-          o \b représente les caractères d'espacement
-          o \B représente la négation de \b
-
-    * Un remplacement d'une occurence par une chaine s'écrit : /chaine1/chaine2/, ou chaine2 viendra remplacer l'occurence de chaine1. Exemple : /foo/bar/ remplace "foo" par "bar"
-
-    * ?!chaine négative la recherche d'une chaine
-      . Par exemple, pour chercher tous les fichiers autres que ceux ayant l'extension ".bat" ou ".pif", on écrit :
-
-      ^.*\.(?!(bat|pif)$).*$,
-      où :
-          o ^ exprime le début de ligne,
-          o .* une série de caractères quelconques représentant le nom du fichier (sans extension),
-          o \. le caractère ".",
-          o (?!(bat|pif)$) la négation des chaines "bat" ou "pif", et seulement elles puisqu'elles doivent etre suivi du caractère de fin de ligne (présence du symbole $ à la suite),
-          o .* qui désigne les caractères correspondant à l'extension du fichier,
-          o $ pour la fin de ligne.
-