Browse Source

update documentation

Davide Alberani 7 years ago
parent
commit
3d08e157e1
2 changed files with 15 additions and 3 deletions
  1. 5 1
      README.md
  2. 10 2
      docs/DEVELOPMENT.md

+ 5 - 1
README.md

@@ -78,13 +78,17 @@ Now persons can start joining your event:
 - click on "Join this event" in the list of events
 - compile the form and submit it
 - the user will have to keep the provided link, if they want to edit their information later
-- from this, a person can also mark a ticket as "cancelled" (not counted in the list of tickets), or they can enable it again
+- from this link, a person can also mark a ticket as "cancelled" (not counted in the list of tickets), or they can enable it again
 - if the person was a registered user, it's possible to see the list of own tickets in the personal page
 
 As an administrator, you can now go to the list of tickets of the event:
 - from there, once the event has started, you can mark persons as attendees
 - it's also possible to quickly add a new ticket or delete an existing one (the ticket is effectively deleted, it's not the same as the cancelled action)
 
+
+Notes on some special features
+------------------------------
+
 Some notes about the event registration form:
 - field names are important (case is not considered). You can use whatever you want, but "name", "surname" and "email" are internally used to show the tickets list, so please add at least one of them
 - please notice that the "Email" field type has a very silly regular expression and will create a lot of problems: please use "Text input" and names the field "Email"

+ 10 - 2
docs/DEVELOPMENT.md

@@ -203,11 +203,19 @@ The code is so divided:
     +- templates/ - Tornado Web templates (not used)
     +- tests/ - eeeehhhh
 
-Most of the time you have to edit something in angular\_app/js/ (for the logic; especially controllers.js and services.js), angular\_app/*.html (for the presentation) or eventman\_server.py for the backend.
+Most of the time you have to edit something in angular\_app/js/ (for the logic; especially controllers.js and services.js), angular\_app/\*.html (for the presentation) or eventman\_server.py for the backend.
 
+Dependency management and other hipster tools
+---------------------------------------------
+
+But, but, but... you don't use bower/npm/jam/CthulhuJS!
+
+Yes, exactly. I'm too old for that stuff: I just downloaded the third-party libraries that I needed and put them in static/.  Seems to work, by the way.
+
+I you're a big fan of those tools, please go ahead and send me a pull request.
 
 Coding style and conventions
-============================
+----------------------------
 
 It's enough to be consistent within the document you're editing.