aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGabriel Arakaki Giovanini <mail@gabrielgio.me>2023-07-18 23:22:49 +0200
committerGabriel Arakaki Giovanini <mail@gabrielgio.me>2023-07-18 23:23:20 +0200
commit0acfc21f54745990d094b1e6e5de463d4d8a80a3 (patch)
tree640165a82717848c85983c6a6966d9ce04a83f40
parent21a7c204d216ec1a7615156b7c8b85ee2d964b81 (diff)
downloadlens-0acfc21f54745990d094b1e6e5de463d4d8a80a3.tar.gz
lens-0acfc21f54745990d094b1e6e5de463d4d8a80a3.tar.bz2
lens-0acfc21f54745990d094b1e6e5de463d4d8a80a3.zip
doc: Add dev requirements
Add some requirements to run the project.
-rw-r--r--README.md46
1 files changed, 38 insertions, 8 deletions
diff --git a/README.md b/README.md
index e28adc9..2b58f23 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,50 @@
# IMG
A read only file explorer with media capabilities.
+
+# Dev requirements
+
+## qtc
+
+It is used as template engine for html. To install it:
+
+```
+go install github.com/valyala/quicktemplate/qtc@latest
+```
+
+## libvips
+
+Libvips[^1] is required by bimp [^2] used for image manipulation.
+
+## ffmpeg
+
+Used to generate video thumbnail.
+
+## sassc
+
+Sassc[^4] is used to generate the css file from sass.
+
+## Bulma
+
+Bulma is the css framework of choice for this project. It is added as sub-module, so don't forget to pull it.
# TODO
-* Thumbnail system
-* Initial setup process
- * Also allow setup user config file
+* ~~Thumbnail system~~
+* ~~Initial setup process~~
* ~~Single binary output~~
* Better worker pool. Allow cron job and ui config
* Alpine package and demo site
* Single image viewer and show exif info (not sure how yet)
-* User base root folder
-* Albuns
+* ~~User base root folder~~
+* Albums
* Testing. Since I still on initial iteration phases I'm not adding as many
- testing as I'd like to. Once I set on most of the design I'll add testing.
-* Add testing agains db and memory[^1] in preparation for redis implementation
+ testing as I'd like to. Once I set on most of the design I'll add more test
+ (is this even done :thinking:).
-[^1]: https://github.com/alicebob/miniredis
+[^1]: https://github.com/libvips/libvips
+[^2]: https://github.com/h2non/bimg
+[^3]: https://github.com/alicebob/miniredis
+[^4]: https://github.com/sass/sassc
+[^5]: https://github.com/photoview/photoview
+[^6]: https://github.com/photoview/photoview#why-yet-another-self-hosted-photo-gallery