voussoir/etiquette
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update Readme: Stability and Contributing and to-do.

Browse source
This commit is contained in:
voussoir 2017-07-13 23:53:42 -07:00
parent 61ab1fb452
commit a70c1dca7c
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -12,6 +12,15 @@ Documentation is still a work in progress. In general, I use:
- `python etiquette_flask_launch.py [port]` to launch the flask server. Port defaults to 5000 if not provided. - `python etiquette_flask_launch.py [port]` to launch the flask server. Port defaults to 5000 if not provided.
- `python -i etiquette_repl.py` to launch the Python interpreter with the PhotoDB pre-loaded into a variable called `P`. Try things like `P.new_photo` or `P.digest_directory`. - `python -i etiquette_repl.py` to launch the Python interpreter with the PhotoDB pre-loaded into a variable called `P`. Try things like `P.new_photo` or `P.digest_directory`.
### Project stability
You may notice that Etiquette doesn't have a version number anywhere. That's because I don't think it's ready for one. I am using this project to learn and practice, and breaking changes are very common.
### Contributing
If you are interested in helping, please raise an issue before making any pull requests!
### To do list ### To do list
- Make the wording between "new", "create", "add"; and "remove", "delete" more consistent. - Make the wording between "new", "create", "add"; and "remove", "delete" more consistent.
- User account system, permission levels, private pages. - User account system, permission levels, private pages.
@ -24,8 +33,9 @@ Documentation is still a work in progress. In general, I use:
- Add some way to support large image albums without flooding the search results. Considering a "hidden" property so that a handful of representative images can appear in the search results, and the rest can be found on the actual Album page. - Add some way to support large image albums without flooding the search results. Considering a "hidden" property so that a handful of representative images can appear in the search results, and the rest can be found on the actual Album page.
- Add a `Photo.merge` to combine duplicate entries. - Add a `Photo.merge` to combine duplicate entries.
- Generate thumbnails for vector files. - Generate thumbnails for vector files.
- Allow photos to have nonstandard, orderby-able properties like "release year". - Allow photos to have nonstandard, orderby-able properties like "release year". How?
- Make the FFmpeg path configurable. Some kind of global config? Or part of the database config file? - Make the FFmpeg path configurable. Some kind of global config? Or part of the database config file?
- Improve the appearance of album page. Too many section headers and the "Create album" interface should allow giving a title immediately.
### Changelog ### Changelog