Skip to content

Commit

Permalink
v0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
vulppine committed May 6, 2021
1 parent f6b56aa commit 103fdd1
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ fotoDen

*A statically structured, front-end dynamic photo gallery*

[https://github.com/vulppine/fotoDen/wiki](Wiki)
[Wiki](https://github.com/vulppine/fotoDen/wiki)

Using
-----
Expand All @@ -22,9 +22,8 @@ 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
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
Expand All @@ -43,29 +42,29 @@ Installing
----------

You will require the latest version of
[https://github.com/libvips/libvips](libvips) in order to use fotoDen.
[libvips](https://github.com/libvips/libvips) in order to use fotoDen.

You can either install from an existing build (which includes fotoDen.js md5
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~.
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.
[libvips](https://github.com/libvips/libvips), [terser](https://terser.org), and
[Go](https://golang.org) 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
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
Note that fotoDen uses [Standard JS](https://github.com/standard/standard) for
its JavaScript style.

A testing script is included in the root of the repository - run it in your
Expand Down Expand Up @@ -105,4 +104,4 @@ 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)
[CC-BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/)
2 changes: 2 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ The big todo list
- [ ] Document fotoDen.js using JSDoc
- [ ] Split fotoDen.js into several files and change the makefile to combine all the separate JS files (maybe?)
- This may require some fotoDen variables to be more *explicitly* global, as some variables need to be accessed by dynamically loaded modules (e.g., themes)
- Do this for v0.4.0
- [ ] Implement some kind of extension system using ES6 import/export (it's nice to have exif data and justified layout in the default theme, but maybe these should be extended to standard functionality without filling the main fotoDen library up with what is essentially a copy and paste of the code)
- [X] Properly implement image updating
- [X] Possibly merge the functionality of adding images with updating images, doing a preliminary search through the current available items before deciding whether to add the image, or update the image based on name
- [X] Selectable themes
- [X] Ability to build folders and albums from YAML files (JSON will still be kept for front-end purposes)
- [ ] More functions for website templates for static generation (e.g., the ability to create a series of links for web navigation based on another template)
- This is being worked on - however, this is only front-end so far.
- [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?)
Expand Down
2 changes: 1 addition & 1 deletion js/fotoDen.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
*/

const BaseURL = document.getElementById('fd-script').dataset.fdBaseurl
const version = '0.2.0'
const version = '0.3.0'

// global variables

Expand Down

0 comments on commit 103fdd1

Please sign in to comment.