Show
Ignore:
Timestamp:
08/06/08 14:42:11 (5 months ago)
Author:
liamstask
Message:

- update Libraries module doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • firmware/trunk/libraries/libraries.txt

    r704 r791  
    1818/** @defgroup Libraries Libraries 
    1919 Libraries that extend core functionality. 
    20  The MAKE Application Board provides an interface between the MAKE Controller Board and common electronic devices. 
    21  Several subsystems extend the capability of the Controller Board, each with their own functions. 
    22  
    23  If you're using your own interface electronics around the Make Controller, the AppBoard module may not  
    24  necessarily work for you. 
     20 Libraries are modules of code that can be easily added/removed based on the needs of a particular project. 
     21 This is a list of libraries maintained by MakingThings, but you're free to create your own.   
     22 Just add a directory with your source files into the \b libraries directory of the firmware codebase. 
     23  
     24 \section lib_in_project Incorporating a Library into your Project 
     25 If you're using \b mcbuilder, just \b include the library you want to use.   
     26  
     27 If you're building from a Makefile, there are a few extra steps: 
     28 - add the library directory to your list of include directories 
     29 - add each .c file of the library to your list of files to compile 
     30  
     31 In the Makefiles in the example projects in the firmware download, you can see the \b THUMB_SRC and  
     32 \b INCLUDEDIRS sections where you can add your own listings of both source files and include directories. 
    2533*/