Просмотр исходного кода

Update documentation and bump version (#48)

* Update README.md

* Bump version

* Update readme
Oleksii Kutuzov 2 лет назад
Родитель
Сommit
8f09e6d5d2
3 измененных файлов с 18 добавлено и 6 удалено
  1. 15 3
      README.md
  2. 2 2
      application.fam
  3. 1 1
      lightmeter_config.h

+ 15 - 3
README.md

@@ -1,7 +1,19 @@
 ## Lightmeter for Flipper Zero
 
-Lightmeter app for photography based on BH1750/MAX44009 sensor
+**Lightmeter app for photography**
 
-## Support
+An application that suggests settings for your manual camera based on the reading of the ambient light sensor. Can also be used in a pure lux meter mode.
 
-For app feedback, bugs, and feature requests, please create an issue here: https://github.com/oleksiikutuzov/flipperzero-lightmeter/issues
+### Supported sensors
+
+- BH1750
+- MAX44009
+
+### Wiring
+
+| Sensor | Flipper Zero |
+| ------ | ------------ |
+| VCC    | 3.3V         |
+| GND    | GND          |
+| SCL    | C0           |
+| SDA    | C1           |

+ 2 - 2
application.fam

@@ -9,7 +9,7 @@ App(
     ],
     stack_size=1 * 1024,
     order=90,
-    fap_version=(1, 0),
+    fap_version=(1, 1),
     fap_icon="lightmeter.png",
     fap_category="GPIO",
     fap_private_libs=[
@@ -28,7 +28,7 @@ App(
             ],
         ),
     ],
-    fap_description="Lightmeter app for photography based on BH1750/MAX44009 sensor",
+    fap_description="Lightmeter app for photography",
     fap_author="Oleksii Kutuzov",
     fap_weburl="https://github.com/oleksiikutuzov/flipperzero-lightmeter",
     fap_icon_assets="icons",

+ 1 - 1
lightmeter_config.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#define LM_VERSION_APP "1.0"
+#define LM_VERSION_APP "1.1"
 #define LM_DEVELOPED "Oleksii Kutuzov"
 #define LM_GITHUB "https://github.com/oleksiikutuzov/flipperzero-lightmeter"