Documentation building work.
[fx2lib.git] / README
blobc2f2f1e822997747d6e27d9ffd74cd0f8994956b
1 Before building this library, you need have sdcc installed and in your path.
3 http://sdcc.sf.net
5 To build this library, run make
7 > make
9 This produces lib/fx2.lib.  You can also run make in the lib folder.
11 You can also build the documentation if you have doxygen installed.
13 > make docs
15 To use routines included with this library in your own firmware,
16 add the include files to your include path and the lib file to your compile command:
18 > sdcc -mmcs51 -I<path to includes> <your c file> fx2.lib -L <path to fx2.lib dir>
20 fx2lib also includes an example program for loading firmware onto your device. 
21 See examples/fx2.
23 Enjoy!
24 Comments, Patches, all welcome.