From 074a69e7c14a719bbf59c4294f7eaf1c77e47de9 Mon Sep 17 00:00:00 2001
From: imi415 <imi415.public@gmail.com>
Date: Sun, 14 Mar 2021 16:40:54 +0800
Subject: [PATCH] Added License and README.

---
 LICENSE   |  8 ++++++++
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..cd30854
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,8 @@
+MIT licence
+Copyright (c) 2021 imi415
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2f80922
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# My sensor runs Linux!
+
+This is the source repository for a simple system monitor program,
+
+which runs on Linux.
+
+## Supported sensors
+
+- [ ] Bosch SensorTec BME280 digital temperature/humidity/pressure sensor
+- [ ] AMS(Sciosense) CCS811 eTVOC sensor
+- [ ] MH-Z19 series NDIR eCO2 sensor 
+- [ ] TDK InvenSense 6-Axis gyro/accelerometer
+- [ ] General GPIO based water detector sensors
+
+## Other supported devices
+
+- [ ] ST7789 IPS TFT LCD(240px * 240px)
+- [ ] General GPIO based buttons
+- [ ] Genetal GPIO based LEDs
+
+## Libraries used
+
+- [x] LittleVGL
+- [ ] mosquitto
+- [ ] libgpiod
+- [ ] libconfig
+- [ ] libpthread
+- [ ] libiio
+
+## How to compile
+
+* Native:
+
+```bash
+mkdir build && cd build
+cmake ..
+make -j${nproc}
+```
+
+* Cross:
+```bash
+mkdir build && cd build
+cmake -DCMAKE_TOOLCHAIN_FILE=${TOOLCHAIN_FILE_NAME} # Replace to yours
+make -j${nproc}
+```