/**

\page Folders Folder structure and project files

The files in the root directory are the common sources which are used by the projects.
Further files in the root directory:
	- The central makefile including targets for building the common sources, the doxygen documentation and deploying.
	- The Doxyfile for building the documentation
	- The workspace file for the MPLAB IDE

All the sources which are licensed by Microchip are located in the seperate Microchip folder.
These are files for EEPROM access via UNIO and the TCPIP Stack modules, the MPFS sources and the bootloader.

The documentation input files like several additional text files and images are located in doc.
The output of the documentation build process is also written to doc.

The final image and hex files are put into the Release folder.

Each project has a seperate folder. 
These files are typically included:
	- The project makefile for configuring the project build process. The file uses the central Makefile in the root directory for buidling the project.
	- The project related source and header files (including projectdefs.h for several project related defines)
	- The project file for the MPLAB IDE
	- The project related linker script
	- The project related website in the web folder
	- The intermediate output files of the build process are put into the bin folder



\page BUILD How to build

\section BuildInst What to install
\subsection Compiler Compiler
The MCC18 Compiler (V3.35 or greater) can be used under a free Student License. 
The latest version can be downloaded from the <a href="http://www.microchip.com">Microchip website</a>.
This license enables the user to compile and link the project modules (The extended mode is not used). 

The MCC18 is available for Window only.
For Linux and MAC you can give the PICC Compiler (http://www.htsoft.com/) a try (I have not tried this, please let me know if it works).


\subsection IDE IDE
The MPLAB IDE (V8.5 or greater) is free but for Windows only.
The latest version can be downloaded from the <a href="http://www.microchip.com">Microchip website</a>.
Workspace and project files for MPLAB are included in this project.

Alternativly you can use MinGW and the included makefiles to build the project.
Also any IDE (i.e. Eclipse) where a make process can be started is possible.


\subsection MPFSVisualStudio MPFS and VisualStudio
For compiling the project web sites to a MPFS image the MPFS tool is needed.
The MPFS Tool, intergrated in Microchips TCP/IP Stack, was modified for these project.
The sources and an already compiled executable (in the MPFS folder) are included in this software package.
If you'd like to compile the sources due own modifications you need Microsofts Visual Studio Express for C# (freely available at Microsoft).
The MPLAB project files include the build of the web image as prebuild steps.
The makefile includes a target for the MPFS image.

The MPFS image itself is an ANSI C file which is simply compiled within the build process.


\section BuildHowMPLAB How to build with MPLAB
Simply open the root workspace file *.mcw with the MPLAB IDE. 
Activate the project, your prefered mode, the appropriate Debugger or Programmer and select "Build All". 
When the build process has finished the generated image file is located in the Release folder.
Continue with programming or debugging the device with the output <i>*.cof</i> and <i>*.hex</i> files.

\image html Debug.gif Activating the debug mode
This mode is for real time hardware debugging on i.e. a Microchip ICD2. 
The build image is running without the special bootloader and can therefore be flashed directly to the device target. 
In this mode the MAC address and the hostname of the eWicht can freely be choosen due changing them in the appropriate code sections.

\image html Release.gif Activating the release mode
This mode generates an image which can not run without the special bootloader. 
Typically the user will choose this mode because no programmer device like an Microchip ICD2 is needed. 
Simply build the application and use a tftp client for uploading the image (see \ref DEPLOY). 
For changing the MAC address and hostname the bootloader code must be changed.


\section BuildHowMinGW How to build with MinGW
The included makefiles also can be used to build the device images. 
Only release images are generated by default.

*/=