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

Add version to app fam. Update changelog and in-app README.

Cody Tolene 2 лет назад
Родитель
Сommit
f3f32d48ed
3 измененных файлов с 32 добавлено и 25 удалено
  1. 1 0
      src-fap/application.fam
  2. 18 10
      src-fap/docs/CHANGELOG.md
  3. 13 15
      src-fap/docs/README.md

+ 1 - 0
src-fap/application.fam

@@ -8,6 +8,7 @@ App(
     fap_description="A camera suite application for the Flipper Zero ESP32-CAM module.",
     fap_description="A camera suite application for the Flipper Zero ESP32-CAM module.",
     fap_icon="icons/camera_suite.png",
     fap_icon="icons/camera_suite.png",
     fap_libs=["assets"],
     fap_libs=["assets"],
+    fap_version="1.1",
     fap_weburl="https://github.com/CodyTolene/Flipper-Zero-Cam",
     fap_weburl="https://github.com/CodyTolene/Flipper-Zero-Cam",
     name="[ESP32] Camera Suite",
     name="[ESP32] Camera Suite",
     order=1,
     order=1,

+ 18 - 10
src-fap/docs/CHANGELOG.md

@@ -1,12 +1,20 @@
-## v1.1
+## Roadmap
 
 
-- Support and picture stabilization for all camera orientations (0°, 90°, 180°, 270°).
-- Rename "Scene 1" to "Camera". No UX changes, strictly internal.
+- Save image support.
+- Full screen 90° and 270° fill.
+- Camera flash support.
+- In-camera GUI.
+
+## v1.1 (current)
+
+- Support and picture stabilization for all camera orientations (0°, 90°, 180°, and 270°).
+- Rename "Scene 1" to "Camera". No UX changes there.
 - Clean up unused "Scene 2". This was inaccessible to users previously and unused.
 - Clean up unused "Scene 2". This was inaccessible to users previously and unused.
-- Add new dithering variations (needs new module firmware, see https://github.com/CodyTolene/Flipper-Zero-Camera-Suite#firmware-installation):
-  - Add `Jarvis Judice` Ninke Dithering option
-  - Add `Stucki` dithering option.
-  - Add ability to toggle dithering options from default `Floyd-Steinberg` and back.
+- Add new dithering variations (requires the latest firmware installation, see here for the installation guide https://github.com/CodyTolene/Flipper-Zero-Camera-Suite#firmware-installation):
+  - `Jarvis Judice Ninke` dithering option
+  - `Stucki` dithering option.
+  - `Floyd-Steinberg` dithering option.
+  - Cycle through the dithering options with the center button on the Flipper Zero.
 - Resolves issue https://github.com/CodyTolene/Flipper-Zero-Camera-Suite/issues/7
 - Resolves issue https://github.com/CodyTolene/Flipper-Zero-Camera-Suite/issues/7
 - Resolves issue https://github.com/CodyTolene/Flipper-Zero-Camera-Suite/pull/17
 - Resolves issue https://github.com/CodyTolene/Flipper-Zero-Camera-Suite/pull/17
 
 
@@ -14,7 +22,7 @@
 
 
 - Builds upon Z4urce's software found here (updated 6 months ago): https://github.com/Z4urce/flipperzero-camera
 - Builds upon Z4urce's software found here (updated 6 months ago): https://github.com/Z4urce/flipperzero-camera
 - Utilizes the superb C boilerplate examples laid out by leedave (updated last month): https://github.com/leedave/flipper-zero-fap-boilerplate
 - Utilizes the superb C boilerplate examples laid out by leedave (updated last month): https://github.com/leedave/flipper-zero-fap-boilerplate
-- Repurpose and build upon the "[ESP32] Camera" software into the new "[ESP32] Camera Suite" application with new purpose:
-  - Adding more scene for a guide.
-  - Adding more scene for saveable settings.
+- Builds upon the "[ESP32] Camera" software into the new "[ESP32] Camera Suite" application with new usage:
+  - Add a scene for a guide.
+  - Add a scene for settings.
   - Add ability to rotate the camera orientation.
   - Add ability to rotate the camera orientation.

+ 13 - 15
src-fap/docs/README.md

@@ -2,23 +2,27 @@
 
 
 Software to run an ESP32-CAM module on your Flipper Zero device.
 Software to run an ESP32-CAM module on your Flipper Zero device.
 
 
-## Software Guide <a name="software-guide"></a>
+Full setup, wiring guide, etc. in the main project README here: https://github.com/CodyTolene/Flipper-Zero-Camera-Suite
+
+Firmware is needed for the ESP32-CAM module, see here for more information: https://github.com/CodyTolene/Flipper-Zero-Camera-Suite#firmware-installation
 
 
-### Flipper Zero button mappings:
+## Software Guide
 
 
-🔼 = Contrast Up
+### Button mappings:
 
 
-🔽 = Contrast Down
+**Up** = Contrast Up
 
 
-◀️ = Toggle invert.
+**Down** = Contrast Down
 
 
-▶️ = Toggle dithering on/off.
+**Left** = Toggle invert.
 
 
-⚪ = Cycle Floyd–Steinberg/Jarvis-Judice-Ninke/Stucki dithering types.
+**Right** = Toggle dithering on/off.
 
 
-↩️ = Go back.
+**Center** = Cycle Floyd–Steinberg/Jarvis-Judice-Ninke/Stucki dithering types.
 
 
-### Camera Suite settings:
+**Back** = Go back.
+
+### Settings:
 
 
 **Orientation** = Rotate the camera image 90 degrees counter-clockwise starting at zero by default (0, 90, 180, 270). This is useful if you have your camera module mounted in a different orientation than the default.
 **Orientation** = Rotate the camera image 90 degrees counter-clockwise starting at zero by default (0, 90, 180, 270). This is useful if you have your camera module mounted in a different orientation than the default.
 
 
@@ -27,9 +31,3 @@ Software to run an ESP32-CAM module on your Flipper Zero device.
 **Sound FX** = Toggle sound effects on/off.
 **Sound FX** = Toggle sound effects on/off.
 
 
 **LED FX** = Toggle LED effects on/off.
 **LED FX** = Toggle LED effects on/off.
-
-## Links
-
-Full setup, wiring guide, etc. in the main project README here: https://github.com/CodyTolene/Flipper-Zero-Camera-Suite
-
-A firmware is needed for the ESP32-CAM module, see here for more information: https://github.com/CodyTolene/Flipper-Zero-Camera-Suite#firmware-installation