english readme

README_EN.md

@@ -0,0 +1,82 @@
+This is an automatic translation, may be incorrect in some places. See sources and examples!
+
+# rtc_utils
+Wrapping for more convenient use of RTC memory on ESP8266
+- Reading and recording
+- CRC32 control
+
+## compatibility
+ESP8266
+
+## Content
+- [use] (#usage)
+- [versions] (#varsions)
+- [installation] (# Install)
+- [bugs and feedback] (#fedback)
+
+<a id="usage"> </a>
+
+## Usage
+`` `CPP
+// Record data in RTC memory.Will return FALSE with an error
+Bool RTC_Write (T* DATA, UINT8_T OFFSET = 0);
+
+// Read data from RTC memory.Will return FALSE with an error
+Bool RTC_read (T* DATA, UINT8_T OFFSET = 0);
+`` `
+
+- maximum `offseet` - 128, one unit - 4 memory of memory
+- The library is preparing 4 bytes of CRC in the beginning of the region, we take this into account when calculating displacements for other data
+- you can store any data (structures, arrays)
+
+### Examples
+`` `CPP
+// Microcontroller rebooting counter
+
+VOID setup () {
+Uint16_T Count = 0;
+RTC_Read (& Count);
+
+Serial.println (Count);
+
+Count ++;
+RTC_WRITE (& COUNT);
+}
+`` `
+
+<a id="versions"> </a>
+
+## versions
+- V1.0
+
+<a id="install"> </a>
+## Installation
+- The library can be found by the name ** rtc_utils ** and installed through the library manager in:
+- Arduino ide
+- Arduino ide v2
+- Platformio
+- [download the library] (https://github.com/gyverlibs/rtc_utils/archive/refs/heads/main.zip) .Zip archive for manual installation:
+- unpack and put in * C: \ Program Files (X86) \ Arduino \ Libraries * (Windows X64)
+- unpack and put in * C: \ Program Files \ Arduino \ Libraries * (Windows X32)
+- unpack and put in *documents/arduino/libraries/ *
+- (Arduino id) Automatic installation from. Zip: * sketch/connect the library/add .Zip library ... * and specify downloaded archive
+- Read more detailed instructions for installing libraries [here] (https://alexgyver.ru/arduino-first/#%D0%A3%D1%81%D1%82%D0%B0%BD%D0%BE%BE%BE%BED0%B2%D0%BA%D0%B0_%D0%B1%D0%B8%D0%B1%D0%BB%D0%B8%D0%BE%D1%82%D0%B5%D0%BA)
+### Update
+- I recommend always updating the library: errors and bugs are corrected in the new versions, as well as optimization and new features are added
+- through the IDE library manager: find the library how to install and click "update"
+- Manually: ** remove the folder with the old version **, and then put a new one in its place.“Replacement” cannot be done: sometimes in new versions, files that remain when replacing are deleted and can lead to errors!
+
+<a id="feedback"> </a>
+
+## bugs and feedback
+Create ** Issue ** when you find the bugs, and better immediately write to the mail [alex@alexgyver.ru] (mailto: alex@alexgyver.ru)
+The library is open for refinement and your ** pull Request ** 'ow!
+
+When reporting about bugs or incorrect work of the library, it is necessary to indicate:
+- The version of the library
+- What is MK used
+- SDK version (for ESP)
+- version of Arduino ide
+- whether the built -in examples work correctly, in which the functions and designs are used, leading to a bug in your code
+- what code has been loaded, what work was expected from it and how it works in reality
+- Ideally, attach the minimum code in which the bug is observed.Not a canvas of a thousand lines, but mTonimous code