Add a nice readme

Nitepone · Jun 3, 2023 · 32b9a99 · 32b9a99
1 parent cef7ca8
commit 32b9a99
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,40 @@
 # An Intervalometer App For Flipper Zero
+
+![](./doc/img/app-icon.png)
+
+![](./doc/img/running-intervalometer.png)
+
+This is a simple configurable valometer app for Sony cameras. It provides a
+configurable shutter timer and uses the IR blaster to trigger the camera
+shutter.
+
+## Configuration
+
+![](./doc/img/settings-initial.png)
+
+The default configuration functions just as a 2 second self timer.
+
+![](./doc/img/settings-edit.png)
+
+This can be easily configured to do something like a 12 shot timelapse over 1 hour.
+
+![](./doc/img/settings-burst.png)
+
+Scrolling down the settings page, there is also the option to shoot a "burst"
+of images at each interval.
+
+# Building
+
+1. Download the Flipper firmware repo at: https://github.com/flipperdevices/flipperzero-firmware
+2. Inside the Flipper fw repo, copy this repo into `./applications_user/intervalometer/`
+3. Run `./fbt fap_intervalometer`
+4. Read the output of `fbt` to find the `.fap` in `./build/`
+
+# TODO
+
+1. Add support for additional trigger types, such as bluetooth and other cameras.
+2. Add support for using more advanced camera controls like exposure compensation
+   to allow for shooting an exposure bracket.
+3. Add github actions for CI.
+3. Refactor the codebase to be cute.
+
diff --git a/doc/img/app-icon.png b/doc/img/app-icon.png
diff --git a/doc/img/running-intervalometer.png b/doc/img/running-intervalometer.png
diff --git a/doc/img/settings-burst.png b/doc/img/settings-burst.png
diff --git a/doc/img/settings-edit.png b/doc/img/settings-edit.png
diff --git a/doc/img/settings-initial.png b/doc/img/settings-initial.png