r11563: add doc file
[cluck.git] / cluck.txt
1 Cluck is a Common Lisp library to help automate clock and divisor
2 selections for microcontrollers.
3
4 Functions include:
5
6 1. show-timers
7     Shows range of frequency and periods for 8 and 16-bit timers
8     for a given clock frequency
9
10 2. ms-timer
11     Shows prescaler, compare values, and percent errors
12     for 8 and 16 times to acheive desired millisecond compare interrupts.
13
14 3. avr-uart-divisors / pic-uart-divisors
15     Shows optimal divisors and percent error for common baud
16     for serial communications
17
18 4. zero-error-uart-clocks
19     Display common crystal frequencies that have zero uart timin errors
20     for common serial communication rates
21
22