From 467d5a262647ce948bacc8735daffc45cf4f9137 Mon Sep 17 00:00:00 2001 From: Ethan Dalool Date: Fri, 17 Mar 2017 15:24:59 -0700 Subject: [PATCH] Add basic project description to readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index fe06ab4..27b15ba 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,15 @@ Etiquette I am currently running a demonstration copy of Etiquette at http://etiquette.voussoir.net where you can browse around. This is not yet permanent. +### What am I looking at + +Etiquette is a tag-based file organization system with a web front-end. + +Documentation is still a work in progress. In general, I use: + +- `python etiquette_site_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`. + ### To do list - Make the wording between "new", "create", "add"; and "remove", "delete" more consistent. - User account system, permission levels, private pages.