From 3ea8bc15d00dab19eeb84dfa254ebe71e368cd6e Mon Sep 17 00:00:00 2001 From: Joe Hitchens <joe@sleepless.com> Date: Wed, 9 Nov 2011 15:36:55 -0800 Subject: [PATCH] Starting documention --- README | 2 -- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 2 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 91242ef..0000000 --- a/README +++ /dev/null @@ -1,2 +0,0 @@ -Finals Club Development - diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc0da2e --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ + +# Finals Club + +This is the source code repository for [finalsclub.org](http://finalsclub.org/). + +FinalsClub.org is a 501(c)(3) non-profit open education project dedicated to +helping college students collaborate, learn, and share their knowledge freely online. + + + +# Overview + +FinalsClub.org consists of 3 main parts: + +- The collaborative, real-time editor +- The back channel +- The surrounding website + + +## The Collaborative Real-time Editor + +The real-time editor is an embedded editor called +[Etherpad-Lite](https://github.com/Pita/etherpad-lite) (EPL). +It provides the ability for multiple people to simultaneously edit a single document. +The documents in Finals Club are the notes for a specific lecture. + + +## The Back Channel (BC) + +The back channel portion of Finals Club is called ["BC"](https://github.com/FinalsClubDev/BC). +BC allows the note takers, or anyone else who is just observing, +to suggest questions for the lecturer, and vote on each other's questions. +It also allows people to post commentary. + + +## The Surrounding Website + +This is the Finals Club website, which brings together the other two elements into +a single website that serves it's stated purpose (above). +This would be the home page, privacy policy page, the page that lists the participating +schools, the sub pages containing lists of lectures and note taking sessions, and the +core page where EPL and BC are both found along side each other. + + + + -- 2.25.1