/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to src/utility/README.md

  • Committer: edam
  • Date: 2012-02-25 01:31:43 UTC
  • Revision ID: tim@ed.am-20120225013143-9fet2y2d3fjlrwez
added ulibc

Show diffs side-by-side

added added

removed removed

 
1
# Standard C++ for Arduino
 
2
 
 
3
## What is this?
 
4
 
 
5
This is a straight port of [uClibc++](http://cxx.uclibc.org/) for Arduino.
 
6
I have cut nothing out and held nothing back.  Use with care!
 
7
 
 
8
That said, I have used uClibc++'s own internal configuration to pare back
 
9
un-needed stuff, like support for floats, gratuitous template 
 
10
instantiations and other things.  See system\_configuration.h for all of
 
11
those gory details.
 
12
 
 
13
Plus I added in [Andy Brown's](http://andybrown.me.uk/ws/2011/01/15/the-standard-template-library-stl-for-avr-with-c-streams/#IDComment246044033)
 
14
excellent ohserialstream class for managing the HardwareSerial as an ostream.
 
15
 
 
16
## How do I install it?
 
17
 
 
18
This is installed just like a regular Arduino library.  Unpack the contents
 
19
of the distribution into the 'libraries' folder under your sketchbook.  For
 
20
example, my sketchbook is at /home/maniacbug/Source/Arduino, so this
 
21
library is in /home/maniacbug/Source/Arduino/libraries/StandardCplusplus .
 
22
 
 
23
Be sure to reset your Arduino IDE after installing it.
 
24
 
 
25
## How do I try it out?
 
26
 
 
27
From the Arduino IDE, navigate the menus to:
 
28
File > Examples > StandardCplusplus > string\_vector
 
29
 
 
30
Upload that, set your serial monitor to 57600 baud, and check the output.
 
31
 
 
32
## How do I learn more?
 
33
 
 
34
The web is your friend.  [cplusplus.com](http://cplusplus.com/reference/) is my personal favorite reference.
 
35
 
 
36
## Which versions does it work with?
 
37
 
 
38
Arduino 1.0 and beyond.
 
39
 
 
40
## What is the license?
 
41
 
 
42
uClibc++ is LGPL, so this port is also.  Andy's <serstream> file is actually
 
43
CC-BY-SA, however he indicated he'd be releasing it using the 3-clause
 
44
modified BSD license, so it will be fully compatible with uClibc++.