#------------------------------------------------------------------------------
#--  This file is a part of the libuc, microcontroler library
#--  Copyright (C) 2012, Alexis Jeandet
#--
#--  This program is free software; you can redistribute it and/or modify
#--  it under the terms of the GNU General Public License as published by
#--  the Free Software Foundation; either version 3 of the License, or
#--  (at your option) any later version.
#--
#--  This program is distributed in the hope that it will be useful,
#--  but WITHOUT ANY WARRANTY; without even the implied warranty of
#--  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#--  GNU General Public License for more details.
#--
#--  You should have received a copy of the GNU General Public License
#--  along with this program; if not, write to the Free Software
#--  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#-------------------------------------------------------------------------------
#--                 Author : Alexis Jeandet
#--                   Mail : alexis.jeandet@member.fsf.org
#-------------------------------------------------------------------------------

________
licence:
~~~~~~~~
	Please note that all the files included inside the libuc2 are not written by me and for the libuc2. They are covered by their 
own licence. If you reconize any of your code and you whant it to be removed from this library tell me.

____________
Intallation:
~~~~~~~~~~~~
	-On linux you must copy the libuc2 folder to /opt/libuc2. Then you will be able to use /opt/libuc2/bin/qmake-libuc2 to generate Makefiles et build it.

________________
Building libuc2:
~~~~~~~~~~~~~~~~
	Usualy you work on one architecture at time, when you build the libuc2 you build it for one architecture at time but you can sequencially build it for 
  several architectures. First you have to generate Makefiles with qmake, call qmake in the libuc2 root folder with your target architecture as argument:
     /opt/libuc2/bin/qmake-libuc2 UCMODEL=stm32f4  # Building for stm32f4
     make -j 4                                     # 4 if you have 4 core 

	You can also work with QtCreator, just remember to set UCMODEL variable in your prject configuration.

______________
Contributions:
~~~~~~~~~~~~~~
	Feel free to modify everything in the libuc2, if you think that some of your improvement should be integrated in the 
libuc2 you can send them to me at alexis.jeandet@member.fsf.org or alexis.jeandet@gmail.fr.

______________
Documentation:
~~~~~~~~~~~~~~
	You can find some documentation in the Doc folder. But as the libuc, the documentation is not already finished.