Merge pull request #13 from tobozo/unstable

Documentation update

README.md

@@ -1,140 +1,67 @@
-# M5Stack Library
+# ESP32-Chimera-Core Library
 
-English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
+This library is a *substitute* of the original [M5Stack](https://github.com/m5stack/M5Stack/) library, with added support for the following devices:
 
-Welcome to program with M5Stack Core
+  - M5Stack Classic
+  - M5Stack Fire
+  - Odroid-Go
+  - D-Duino-32-XS
+  - ESP32-Wrover-Kit (v4.1, v4.2, v4.3)
 
-## 1. Get Started
 
-#### Here is the article to get started
+It also implements a set of extra features:
 
-*1.For MacOS*
+  - Zero-config automatic device selection based on the Arduino Boards menu selection
+  - Screenshots!
+  - I2C Scanner
 
-https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS
 
-*2. For Windows*
+# Usage
 
-https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows
+  - Download the latest release and unzip it in the `~/Arduino/libraries` folder.
+  - Delete the `~/Arduino/M5Stack` folder to prevent any confusion at compilation (you can still restore it later using the Library Manager)
+  - You're done!
 
+# Developers
 
-## 2. Example
+Use `#if defined(_CHIMERA_CORE_)` macros to isolate ESP32-Chimera-Core specific statements.
 
-https://github.com/m5stack/M5Stack/tree/master/examples
+  ```C
+    #if defined(_CHIMERA_CORE_)
+      M5.ScreenShot.init( &M5.Lcd, M5STACK_SD );
+      M5.ScreenShot.begin();
+      M5.ScreenShot.snap();
+    #endif
 
-## 3. API Reference
+  ```
 
-https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19
+Automatic board selection is based on the boards.txt definition, so changing the board from the Arduino Tools menu is enough to trigger the detection.
+Sketch compilation can eventually be tuned-up to a specific device by using macros.
 
-https://docs.m5stack.com/#/en/api
+  ```C
+    #if defined(_CHIMERA_CORE_)
+      #if defined( ARDUINO_M5Stack_Core_ESP32 )
+        #warning M5STACK CLASSIC DETECTED !!
+      #elif defined( ARDUINO_M5STACK_FIRE )
+        #warning M5STACK FIRE DETECTED !!
+      #elif defined( ARDUINO_ODROID_ESP32 )
+        #warning ODROID DETECTED !!
+      #elif defined ( ARDUINO_ESP32_DEV )
+        #warning WROVER DETECTED !!
+      #else
+        #warning NOTHING DETECTED !!
+      #endif
+    #else
+      #warning M5Stack legacy core detected
+    #endif
+  ```
 
-## 4. H/W Reference
 
-#### Pinout
+# Credits & Thanks
 
-*We have several kinds of M5Cores, There is [their difference in schematic](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores.md).*
+  - Special thanks to [らびやん (Lovyan03)](https://github.com/lovyan03) for providing strong inspiring support, unconditional kindness and unlimited patience
+  - Kudos to [M5Stack](https://github.com/m5stack) for being the creators of the original M5Stack and its legacy library without which this project would not exist.
+  - [紅樹　タカオ (Takao Akaki)](https://github.com/mongonta0716)
+  - [Nochi](https://github.com/shikarunochi)
+  - [こばさん](https://github.com/wakwak-koba)
 
-**LCD & TF Card**
-
-*LCD Resolution: 320x240*
-
-<table>
- <tr><td>ESP32 Chip</td><td>GPIO23</td><td>GPIO19</td><td>GPIO18</td><td>GPIO14</td><td>GPIO27</td><td>GPIO33</td><td>GPIO32</td><td>GPIO4</td></tr>
- <tr><td>ILI9341</td><td>/</td><td>MISO</td><td>CLK</td><td>CS</td><td>DC</td><td>RST</td><td>BL</td><td> </td></tr>
- <tr><td>TF Card</td><td>MOSI</td><td>MISO</td><td>CLK</td><td> </td><td> </td><td> </td><td> </td><td>CS</td></tr>
-
-</table>
-
-**Button & Speaker**
-
-<table>
- <tr><td>ESP32 Chip</td><td>GPIO39</td><td>GPIO38</td><td>GPIO37</td><td>GPIO25</td></tr>
- <tr><td>Button Pin</td><td>BUTTON A</td><td>BUTTON B</td><td>BUTTON C</td></tr>
- <tr><td>Speaker</td><td> </td><td> </td><td> </td><td>Speaker Pin</td></tr>
-</table>
-
-**GROVE A**
-
-<table>
- <tr><td>ESP32 Chip</td><td>GPIO22</td><td>GPIO21</td></tr>
- <tr><td>GROVE A</td><td>SCL</td><td>SDA</td></tr>
-</table>
-
-
-### M-BUS
-![image](docs/M-BUS.jpg)
-
-## 5. USER CASES
-
-* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD
-  card
-
-* [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI)  - TFT library for the ESP8266 and ESP32 that supports different driver chips
-
-
-* [M5Widgets](https://github.com/Kongduino/M5Widgets) - Widgets for the M5Stack
-
-* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack
-
-* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32)
-
-* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - A lightweight GUI framework suitable for embedded displays
-
-* [M5ez](https://github.com/ropg/M5ez) - The easy way to program on the M5Stack
-
-
-* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - A M5Stack firmware made on PlatformIO
-
-
-* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - A fully functional oscilloscope based on ESP32 M5Stack
-
-* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - An M5Stack library for rendering avatar faces
-
-* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - Crack your M5Stack!!
-
-* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5_Shuttle_Run
-
-* [nixietubeM5](https://github.com/drayde/nixietubeM5) - (Fake) Nixie Tube Display on a M5Stack
-
-* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - A small Bitcoin price ticker using an M5Stack (ESP32) and the Coindesk API
-
-* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - Dependence on example Wifi Setting to get ETH Price from Maicoin
-
-* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 Packet Monitor
-
-* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - Graphic Equalizer on the M5Stack platform
-
-* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - Playing mp3 stream out of internet using M5Stack prototype
-
-* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - MP3 player for M5Stack
-
-* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK Arduino WiFi Photo Backup device
-
-* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - You can send ctrl+alt+del to your PC from M5Stack
-
-* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - Markdown & icons loaded from an Micro SD card/TF card to run a web page
-
-* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - Tetris for M5Stack Ported to M5Stack by macsbug - https://macsbug.wordpress.com/
-
-* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird Playable
-
-* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - Space Invaders knock-off for M5Stack
-
-* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - Pacman on M5Stack/PSP Joypad, with sounds
-
-* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack Thermal Camera with AMG8833 thermal sensor
-
-* [M5Stack-3DPrintFiles](https://github.com/PartsandCircuits/M5Stack-3DPrintFiles) - Links to files for 3D printing custom case parts for the M5Stack
-
-* [truetype2gfx](https://github.com/ropg/truetype2gfx) - Converting fonts from TrueType to Adafruit GFX
-
-* [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) - Full size qwerty keyboard for M5Stack
-
-#### Note:
-
-* How to install USB driver for establishing serial port
-
-  https://docs.m5stack.com/#/en/related_documents/establish_serial_connection
-
-* How to upgrade M5Stack Libary
-
-  https://docs.m5stack.com/#/en/related_documents/upgrade_m5stack_lib