add a brief usage bit
- ID
9eacb35- date
2023-05-14 15:52:36+00:00- author
Alex Chan <alex@alexwlchan.net>- parent
e9f071a- message
add a brief usage bit- changed files
1 file, 17 additions
Changed files
README.md (2371) → README.md (2585)
diff --git a/README.md b/README.md
index 1a9a7e9..4d6890b 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,8 @@ I can use the following commands:
* `c` – add the photo to my "Cross stitch" album
* `o` – open the photo in Photos.app
+
+
## Motivation
When I take photos, I often take a lot of similar shots so that I'm more likely to get a good picture.
@@ -30,6 +32,8 @@ This app is my replacement for the reviewing portion of Darkroom – I can switc
[Darkroom]: https://darkroom.co/
[Flag & Reject workflow]: https://medium.com/@jasperhauser/manage-your-growing-darkroom-photo-library-with-flag-reject-77c9e1816ef2
+
+
## How it works
<img src="architecture.png">
@@ -45,3 +49,16 @@ If you're interested in the details of how I'm talking to Photos.app, you might
[event]: https://developer.mozilla.org/en-US/docs/Web/API/Element/keydown_event
[PhotoKit framework]: https://developer.apple.com/documentation/photokit
+
+
+
+## Usage
+
+This is only designed for use on my Mac, so it might not work elsewhere.
+
+If you want to try, you can start the app with:
+
+```console
+$ pip3 install --user requirements.txt
+$ python3 server.py
+```