alberanid/eventman
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs clean-up

Browse source
This commit is contained in:
Davide Alberani 2016-05-13 22:55:28 +02:00
parent fba01b6753
commit 1be3ec6d76
2 changed files with 23 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -3,11 +3,23 @@ Event Man(ager)
Your friendly manager of attendees at an event.
EventMan will help you handle your list of attendees at an event, managing the list of registered persons and marking persons as present.
Main features:
- quickly mark a registered person as an attendee.
- easy way to add a new person, if it's already known from a previous event.
- fast and simple way to add a completely new person.
- it's easy to import EventBrite CSV files.
- RESTful interface
- ability to run triggers to respond to an event (e.g. when a person is marked as attending to an event)
See the *screenshots* directory for some images.
Development
===========
See the DEVELOPMENT.md file for more information about how to contribute.
See the *docs/DEVELOPMENT.md* file for more information about how to contribute.
Technological stack
@ -23,16 +35,6 @@ The web part is incuded; you need to install Tornado, MongoDB and the pymongo mo
If you want to print labels using the _print\_label_ trigger, you may also need the pycups module.
Coding style and conventions
============================
It's enough to be consistent within the document you're editing.
I suggest four spaces instead of tabs for all the code: Python (**mandatory**), JavaScript, HTML and CSS.
Python code documented following the [Sphinx](http://sphinx-doc.org/) syntax.
Install and run
===============

19
docs/DEVELOPMENT.md
View file

@ -7,15 +7,6 @@ Definitions:
- **attendee**: a person who actually *show up* (checked in) at the event
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) (**DONE**)
- mark registered persons as present (including them in the list of attendees) (**DONE**)
- execute actions when an attendee shows up or enters/leaves the event (**DONE**)
- show information and statistics about registered persons, attendees and events (**DONE**)
Paths
=====
@ -151,6 +142,16 @@ To generate the hash, use:
print utils.hash_password('MyVerySecretPassword')
Coding style and conventions
============================
It's enough to be consistent within the document you're editing.
I suggest four spaces instead of tabs for all the code: Python (**mandatory**), JavaScript, HTML and CSS.
Python code documented following the [Sphinx](http://sphinx-doc.org/) syntax.
TODO
====