Update docs

Author: andygock

Doxyfile

@@ -1666,7 +1666,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = NO
+GENERATE_LATEX         = YES
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1837,7 +1837,7 @@ LATEX_TIMESTAMP        = NO
 # readers/editors.
 # The default value is: NO.
 
-GENERATE_RTF           = NO
+GENERATE_RTF           = YES
 
 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

README.md

@@ -7,47 +7,49 @@ Maintained by Andy Gock
 
 https://github.com/andygock/avr-uart
 
-Derived from original library by Peter Fleury
+Derived from original library by Peter Fleury.
 
-Interrupt UART library using the built-in UART with transmit and receive circular buffers.
+Interrupt driven UART library using the built-in UART with circular transmit and receive buffers.
 
 An interrupt is generated when the UART has finished transmitting or
 receiving a byte. The interrupt handling routines use circular buffers
 for buffering received and transmitted data.
 
 ## Setting up
 
-The `UART_RXn_BUFFER_SIZE` and `UART_TXn_BUFFER_SIZE` constants define
-the size of the circular buffers in bytes. Note that these constants must be a power of 2.
-You may need to adapt this constants to your target and your application by adding to your
-compiler options:
+The `UART_RXn_BUFFER_SIZE` and `UART_TXn_BUFFER_SIZE` symbols define
+the size of the circular buffers in bytes. These values **must be a power of 2**.
+You may need to adapt this symbols to your target and your application by adding into your compiler options:
 
 	-DUART_RXn_BUFFER_SIZE=nn -DUART_TXn_BUFFER_SIZE=nn
 
-`RXn` and `TXn` refer to UART number, for UART3 with 128 byte buffers, add:
+`RXn` and `TXn` refer to the UART number, for UART3 with 128 byte buffers, add:
 
 	-DUART_RX3_BUFFER_SIZE=128 -DUART_TX3_BUFFER_SIZE=128
 
-UART0 is always enabled by default, to enable the other available UARTs, add the following
-to your compiler options (or symbol options), for the relevant USART number:
+UART0 is always enabled by default, to enable the other available UARTs, add the following to your compiler's symbol options for the relevant UART (also known as USART) number.
 
 	-DUSART1_ENABLED -DUSART2_ENABLED -DUSART3_ENABLED
 
-To enable large buffer support (over 256 bytes, up to 2^16 bytes) use:
+To enable large buffer support (over 256 bytes, up to 2^15 bytes) use:
 
 	-DUSARTn_LARGE_BUFFER
 
-Where n = USART number.
+Where n = USART number. The maximum buffer size is 32768.
 
-Supports AVR devices with up to 4 hardware USARTs.
+This library supports AVR devices with up to 4 hardware USARTs.
 
 ### Compiler flags
 
-- AVR/GNU C compiler requires the `-std=gnu99` flag.
+AVR/GNU C compiler requires the `-std=gnu99` flag.
 
 ## Documentation
 
-Doxygen based documentation will be coming soon.
+Doxygen based documentation can be viwed at:
+
+* HTML: <https://andygock.github.io/avr-uart-documentation/html/index.html>
+* PDF: <https://andygock.github.io/avr-uart-documentation/latex/refman.pdf>
+* RTF: <https://andygock.github.io/avr-uart-documentation/rtf/refman.rtf>
 
 ## Notes