adding documentation

README.md

@@ -4,62 +4,44 @@ Table of contents
 ---------------------------
 
   * [Overview](#overview)
-  * [Installation](#installation)
-  * [Hardware](#hardware)
-  * [Features](#features)
-  * [Files](#files)
+  * [Libraries](#libraries)
+  * [Output](#output)
+  * [Schematic](#schematic)
 
 Overview
 --------------------
-* Name : Max471
-* Title : Small library for Max 471 current and voltage sensor for the Arduino eco-system
+* Name : MAX471_VI_Meter
+* Title : Arduino Project , Voltage and current meter based on MAX471 sensor 
 * Description : 
 
-1. Current reading     0-3 A
-2. Voltage reading   3-25 V
-3. ATmega328 battery internal reference voltage supported. 
+1. Current reading  range  0-3 A 
+2. Voltage reading  range 3-25 V
+3. ATmega328 battery internal reference voltage used for analog measurements
+4. Output to LCD and  serial monitor
 
 * Author: Gavin Lyons
 * Arduino IDE: 1.8.16
 * Copyright: GNU GPL v3
 
+Libraries
+------------------------
 
-Installation
-------------------------------
-
-The library is not included in the official Arduino library manger.
-Install by copying folder into your Arduino IDE library folder.
-
-[Installing Additional Arduino Libraries guide](https://www.arduino.cc/en/Guide/Libraries)
-
-Hardware
-----------------------------
-
-Tested with this module. 
+Libraries used both from Author.
 
-![ h](https://github.com/gavinlyonsrepo/MAX471/blob/main/extras/image/max471.jpg)
+1. [MAX471](https://github.com/gavinlyonsrepo/MAX471)
+2. [ERM19264_UC1609]( https://github.com/gavinlyonsrepo/ERM19264_UC1609)
 
-Connect two ADC pins for voltage = VT &  current = AT. 
-Connect Vout(+RS) to PSU.
-Connect Vin(-RS) to circuit/device under test.
+Notes:
+When using the LCD library fonts 1-3 must be enabled in font file and multi-buffer mode
+selected. re MAX471 library, If deciding to use a different IC not based on ATmega328p  the Vref would have to changed from VCC_BAT in constructor.
 
 
-Features
-------------------------
-Example file outputs data to Serial monitor.
-When declaring the constructor list, possible values for ADC resolution and Voltage reference(mV) are in keywords.txt. If user wishes to use a custom value not in this list , 
-cast the custom int value to the relevant enum. 
+Output
+--------------------------
 
-If user is using an ATmega328 and wishes to use internal battery reference  voltage.
-They can pass VCC_BAT to constructor. Using this requires battery voltage for best result
-see notes in function header in cpp file.  If using another IC other than ATmega328p
-then  comment out the define in header file to avoid compile errors.
+![o](https://github.com/gavinlyonsrepo/MAX471_PVI_METER/blob/main/extras/image/output.jpg)
 
-Files
--------------------
+Schematic
+-------------------------------
 
-| Src Files| Desc |
-| ------ | ------ |
-| MAX471.h | library header file  |
-| MAX471.cpp |  library  source file  |
-| MAX471_basic_usage | example file  |  
+![s](https://github.com/gavinlyonsrepo/MAX471_PVI_METER/blob/main/extras/image/sch.jpg)