summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..00674ff
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+cph.rs attendee
+===============
+Creates an A4 tick-off list from a meetup.com organizer export.
+
+ • Generates one file with attendees, and one with those who are waitlisted.
+
+Used by cph.rs to take attendance on dead-tree as people arrive.
+
+Prerequisites
+-------------
+Rust and stuff, of course, and the csv (called xls) export reachable through:
+
+ meetup.com → [event] → # Attendees
+ Manage → Manage Attendees → Attendee details
+
+One might also need some tool to convert to a printable file, unless having a
+printer which understands the Scalable Vector Graphics format.
+
+Usage
+-----
+Simply call:
+
+```
+ cphrs-attendance <meetup-export.xls>
+ inkscape --export-filename=<attendees.pdf> <meetup-export.svg>
+ inkscape --export-filename=<waitlist.pdf> <meetup-export-waitlist.svg>
+```
+
+Future work/Wishlist
+--------------------
+Not implemented, but maybe possibly sometime?
+
+ • Supporting also for post-event follow-up features.
+ • Detection and visualization of RSVP time and when someone got migrated from
+ the waiting list.
+ • Integration with [raffle](https://github.com/vanjacosic/raffle)?
+ • Tablet computer support, to skip the need for manually syncing hard-copies.
+ Unresearched Idea: Generation of pdf with forms for any iPad/android?
+ Unresearched Idea: Cursive front-end, for postmarketOS devices?
+ • OCR/AI support, to automate the hard-copy sync and introduce faults?
+
+Patches welcome!