v1.0.0 update
[hackover2013-badge-firmware.git] / Readme.md
1 # LPC1343 Code Base
2
3 This software library is based on the freely available LPC1343 Reference
4 Design available at http://www.microBuilder.eu. Unless otherwise stated,
5 all files are licensed under the BSD license (see license.txt for details).
6
7 ## Downloads
8
9 The latest version of the software is always available on github at:
10
11 https://github.com/microbuilder/LPC1343CodeBase
12
13 ## Development Status
14
15 While there are almost certainly bugs and chunks of decidedly
16 mediocre code in the library, after two years or so of fairly
17 steady development effort, the core code should be fairly
18 reliable. Some drivers in the /drivers folder are incomplete,
19 and may have been abandoned once the basic features were working
20 (setting pixels on a display, etc.), but they should serve as
21 a good starting point for a wide variety of peripherals.
22
23 ## How Can Someone Support This Project
24
25 A lot of the recent development in this library was done
26 thanks to the financial support of Adafruit Industries (paying
27 me a salary to keep providing this stuff). If you find this library
28 useful, please consider ordering something from the people that
29 make this financially possible: http://www.adafruit.com
30
31 ## Toolchains
32
33 The entire LPC1343 Code Base is based around GCC, and can be built
34 from the command-line using only free tools like the Yagarto
35 distribution for Windows or the Mac, etc.
36
37 Nonetheless, it's often more productive to develop in an IDE with a
38 full set of debugging tools at your disposal, and the code base also
39 includes project files for Rowley Associate's Crossworks for ARM, as
40 well as project files for the free and open source CodeLite, which can
41 be used in combination with a Segger J-Link for ARM and GDB Server.
42
43 Project files for the two IDEs are stored in the /build folder, and
44 project files for the free LPCXpresso IDE are stored in root (see
45 http://www.microbuilder.eu/Projects/LPC1343ReferenceDesign/DebuggingWithLPCXpresso.aspx
46 for more information on using LPCXpresso).
47
48 ## Documentation
49
50 Online documentation is available at the following URLs, though the
51 current documentation reflects and earlier version of the library, and some
52 inconsistencies are present since parts of the library have been
53 reorganized working towards a 1.0.0 release. The graphics library in
54 particular has been reorganized quite a bit.
55
56 General API Documentation:
57 http://www.microbuilder.eu/Projects/LPC1343ReferenceDesign/CodeBaseDocumentation.aspx
58
59 TFT LCD API:
60 http://www.microbuilder.eu/Projects/LPC1343ReferenceDesign/TFTLCDAPI.aspx
61
62 Other tutorials and links:
63 http://www.microbuilder.eu/Projects/LPC1343ReferenceDesign.aspx
This page took 0.05721 seconds and 5 git commands to generate.