From 0c9bf6ce106860d7b88f4c7d462c72c19194969e Mon Sep 17 00:00:00 2001 From: vulppine Date: Sat, 1 May 2021 15:09:42 -0700 Subject: [PATCH] Redoes README and TODO into markdown format Also fixes another thing in tool/web.go --- README.md | 106 ++++++++++++++++++++++++++++++++++++++++++++ README.org | 67 ---------------------------- TODO.org => TODO.md | 5 ++- tool/web.go | 2 +- 4 files changed, 110 insertions(+), 70 deletions(-) create mode 100644 README.md delete mode 100644 README.org rename TODO.org => TODO.md (96%) diff --git a/README.md b/README.md new file mode 100644 index 0000000..d5a7708 --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ +fotoDen ======= + +*A statically structured, front-end dynamic photo gallery* + +[https://github.com/vulppine/fotoDen/wiki](Wiki) + +Using ----- + +fotoDen is designed so that it can be used independent of any separate tool, but +it works well if you have the fotoDen tool in order to create folders and albums +that are directly accessable by fotoDen's front end. + +Using the pre-built fotoDen tool from release is as simple as initializing a +website (with an optional theme - one is already included!) + +``` sh +fotoDen init -i site --name "[ your website name here ]" my_website/ +``` + +From there, you can start generating folders and albums as you wish: + +``` sh +fotoDen create folder --name "[ your folder name here ]" +my_website/my_folder/ fotoDen create album --name "[ your album name here ]" +my/images/are/here my_website/my_folder/my_album +``` + +Run the fotoDen command for more options. (More detailed information and +commands will be added soon, including use of the build system!) + +### Warning + +fotoDen is still in its *very early* stages, at v0 - everything and anything is +subject to change. While I'll attempt to keep its base structure stable, +commands and folder metadata are *subject to change in drastic ways*. Upgrade +paths will be offered for fotoDen version transitions that up the minor version +number (v0 . *y* . 0), so that version transitions with new changes are more +easier. + +Installing +---------- + +You will require the latest version of +[https://github.com/libvips/libvips](libvips) in order to use fotoDen. + +You can either install from an existing build (which includes fotoDen.js md5 +checksums for both the minified version, and the JS file that came with its +release), or you can install the tool alone by running ~go install +github.com/vulppine/fotoDen~. + +Building +-------- + +You will require the latest version of +[https://github.com/libvips/libvips](libvips), [https://terser.org](terser), and +[https://golang.org](Go) in order to build fotoDen from source. + +1. Clone the git repository into a directory of your choice +2. Run ~make all~ in the resulting folder +3. fotoDen will be located in the **build/** folder in the same directory. + +Contributing +------------ + +If you want to contribute, I encourage you to fork and help develop fotoDen! +Note that fotoDen uses [https://github.com/standard/standard](Standard JS) for +its JavaScript style. + +A testing script is included in the root of the repository - run it in your +local environment to generate a test website. Generating the container will +require Docker. + +Dependencies +------------ + +fotoDen relies on a few important dependencies (both front and back), so here +are links to the dependencies that fotoDen uses! License information for +included source code can be found in their respective locations. + +| Dependency | Author | License | +|--------------------|------------------------|------------| +| [bimg] | Tomas Aparicio | MIT | +| [Cobra] | spf13 | Apache 2.0 | +| [Bootstrap] | Twitter/Bootstrap Team | MIT | +| [justified-layout] | Flickr/SmugMug | MIT | +| [exif-js] | Jacob Seidelin | MIT | +| [go-yaml] | go-yaml team | Apache 2.0 | +| [Goldmark] | goldmark team | MIT | + +[bimg]: https://github.com/h2non/bimg +[Cobra]: https://github.com/spf13/cobra +[Bootstrap]: https://github.com/twbs/bootstrap +[justified-layout]: https://github.com/flickr/justified-layout +[exif-js]: https://github.com/exif-js/exif-js +[go-yaml]: https://github.com/go-yaml/yaml +[Goldmark]: https://github.com/yuin/goldmark + + +Copyright +--------- + +fotoDen is copyright 2021 Flipp Syder under the MIT License (see LICENSE for +more information) + +All test images licensed are under the +[https://creativecommons.org/licenses/by-nc-sa/4.0/](CC-BY-NC-SA) diff --git a/README.org b/README.org deleted file mode 100644 index ba6dcc5..0000000 --- a/README.org +++ /dev/null @@ -1,67 +0,0 @@ -* fotoDen -/A statically structured, front-end dynamic photo gallery/ - -[[https://github.com/vulppine/fotoDen/wiki][Wiki]] - -** Using - -fotoDen is designed so that it can be used independent of any separate tool, but it works well if you have the fotoDen tool in order to create folders and albums that are directly accessable by fotoDen's front end. - -Using the pre-built fotoDen tool from release is as simple as initializing a website (with an optional theme - one is already included!) - -#+BEGIN_SRC sh -fotoDen init -i site --name "[ your website name here ]" my_website/ -#+END_SRC - -From there, you can start generating folders and albums as you wish: - -#+BEGIN_SRC sh -fotoDen create folder --name "[ your folder name here ]" my_website/my_folder/ -fotoDen create album --name "[ your album name here ]" my/images/are/here my_website/my_folder/my_album -#+END_SRC - -Run the fotoDen command for more options. (More detailed information and commands will be added soon, including use of the build system!) - -*** Warning - -fotoDen is still in its *very early* stages, at v0 - everything and anything is subject to change. While I'll attempt to keep its base structure stable, commands and folder metadata are *subject to change in drastic ways*. Upgrade paths will be offered for fotoDen version transitions that up the minor version number (v0 . *y* . 0), so that version transitions with new changes are more easier. - -** Installing - -You will require the latest version of [[https://github.com/libvips/libvips][libvips]] in order to use fotoDen. - -You can either install from an existing build (which includes fotoDen.js md5 checksums for both the minified version, and the JS file that came with its release), or you can install the tool alone by running ~go install github.com/vulppine/fotoDen~. - -** Building - -You will require the latest version of [[https://github.com/libvips/libvips][libvips]], [[https://terser.org][terser]], and [[https://golang.org][Go]] in order to build fotoDen from source. - -1. Clone the git repository into a directory of your choice -2. Run ~make all~ in the resulting folder -3. fotoDen will be located in the *build/* folder in the same directory. - -** Contributing - -If you want to contribute, I encourage you to fork and help develop fotoDen! Note that fotoDen uses [[https://github.com/standard/standard][Standard JS]] for its JavaScript style. - -A testing script is included in the root of the repository - run it in your local environment to generate a test website. Generating the container will require Docker. - -** Dependencies - -fotoDen relies on a few important dependencies (both front and back), so here are links to the dependencies that fotoDen uses! License information for included source code can be found in their respective locations. - -| Dependency | Author | License | -|------------------+------------------------+------------| -| [[https://github.com/h2non/bimg][bimg]] | Tomas Aparicio | MIT | -| [[https://github.com/spf13/cobra][Cobra]] | spf13 | Apache 2.0 | -| [[https://github.com/twbs/bootstrap][Bootstrap]] | Twitter/Bootstrap Team | MIT | -| [[https://github.com/flickr/justified-layout][justified-layout]] | Flickr/SmugMug | MIT | -| [[https://github.com/exif-js/exif-js][exif-js]] | Jacob Seidelin | MIT | -| [[https://github.com/go-yaml/yaml][go-yaml]] | go-yaml team | Apache 2.0 | -| [[https://github.com/yuin/goldmark][Goldmark]] | goldmark team | MIT | - -** Copyright - -fotoDen is copyright 2021 Flipp Syder under the MIT License (see LICENSE for more information) - -All test images licensed are under the [[https://creativecommons.org/licenses/by-nc-sa/4.0/][CC-BY-NC-SA]] diff --git a/TODO.org b/TODO.md similarity index 96% rename from TODO.org rename to TODO.md index 086238d..404ba0f 100644 --- a/TODO.org +++ b/TODO.md @@ -1,4 +1,5 @@ -* The big todo list +The big todo list +================= - [ ] GUI mode (Qt?) - Svelte NodeGUI? (it's Qt based, but it would be a wrapper around fotoDen's tool) @@ -18,7 +19,7 @@ - [X] Persistant status bar during lengthy generation (e.g., album generation/folder generation) so that the user knows the current progress of generation - +Not up to spec, but it is implemented - improve before 0.3.0 (by modifying cmdio-go)+ This is implemented via cmdio-go v0.1.3 - [X] Add in static page generation using Markdown (possibly use goldmark?) - - [ ] Integrate it into fotoDen by creating automated site trees/sidebars/etc. + - [X] Integrate it into fotoDen by creating automated site trees/sidebars/etc. - [ ] Add in optional web upload functionality, toggle by flags during build (e.g. NeoCities support, Google Cloud Platform support, so on, so on) - In progress: - [X] NeoCities diff --git a/tool/web.go b/tool/web.go index 396f108..691b6b2 100644 --- a/tool/web.go +++ b/tool/web.go @@ -249,7 +249,7 @@ func GeneratePage(src string, title string) error { err = currentTheme.generateWeb( "page", - filepath.Join(CurrentConfig.RootLocation, title+".html"), + path.Base(u.Path), v, )