r11563: add doc file

[cluck.git] / cluck.txt

diff --git a/cluck.txt b/cluck.txt
new file mode 100755 (executable)
index 0000000..c254895
--- /dev/null
+++ b/cluck.txt
@@ -0,0 +1,22 @@
+Cluck is a Common Lisp library to help automate clock and divisor
+selections for microcontrollers.
+
+Functions include:
+
+1. show-timers
+    Shows range of frequency and periods for 8 and 16-bit timers
+    for a given clock frequency
+
+2. ms-timer
+    Shows prescaler, compare values, and percent errors
+    for 8 and 16 times to acheive desired millisecond compare interrupts.
+
+3. avr-uart-divisors / pic-uart-divisors
+    Shows optimal divisors and percent error for common baud
+    for serial communications
+
+4. zero-error-uart-clocks
+    Display common crystal frequencies that have zero uart timin errors
+    for common serial communication rates
+
+