Browse Source

documentation

Davide Alberani 9 years ago
parent
commit
8dda84f479
2 changed files with 5 additions and 8 deletions
  1. 1 2
      DEVELOPMENT.md
  2. 4 6
      README.md

+ 1 - 2
DEVELOPMENT.md

@@ -10,7 +10,7 @@ Definitions:
 Requirements:
 - create a new event (**DONE**)
 - create a new registered person manually (**DONE**)
-- associate to an event a list of registered persons, creating them if needed (manually and importing from external sources)
+- associate to an event a list of registered persons, creating them if needed (manually and importing from external sources) (**DONE**)
 - mark registered persons as present (including them in the list of attendees) (**DONE**)
 - mark when an attendee enters/leaves the event
 - execute actions when an attendee shows up or enters/leaves the event
@@ -99,7 +99,6 @@ TODO
 Next to be done
 ---------------
 
-- easy way to add a new person to an event
 - add the minimum required fields to lists and detailed pages for persons and events
 - handle datetimes (on GUI with a calendar and on the backend deserializing ISO 8601 strings)
 - modal on event/person removal

+ 4 - 6
README.md

@@ -4,12 +4,8 @@ Event Man(ager)
 Your friendly manager of attendees at an event.
 
 
-Notice
-======
-
-No, this project is not ready, yet.
-
-I'll let you know when I'm finished experimenting with it and you can contribute.
+Development
+===========
 
 See the DEVELOPMENT.md file for more information about how to contribute.
 
@@ -38,6 +34,8 @@ Python code documented following the [Sphinx](http://sphinx-doc.org/) syntax.
 Install and run
 ===============
 
+Be sure to have a running MongoDB server, locally.
+
     wget https://bootstrap.pypa.io/get-pip.py
     sudo python get-pip.py
     sudo pip install tornado