From 0acfc21f54745990d094b1e6e5de463d4d8a80a3 Mon Sep 17 00:00:00 2001 From: Gabriel Arakaki Giovanini Date: Tue, 18 Jul 2023 23:22:49 +0200 Subject: doc: Add dev requirements Add some requirements to run the project. --- README.md | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3