Thes changes are the first since the newest implementation of Clockworks to Django.
[wiki.git] / projects / clockworks.mdwn
index 358f54a8a46be1f16458a306838538270d3096d9..ca7ccf6e98e7940b88349b5a78289e7f13f6bda3 100644 (file)
@@ -1,23 +1,37 @@
-[[!meta title="Doodle Killer"]]
+[[!meta title="Clockworks"]]
 
 Hey guys, I heard there was this app called [Doodle](http://www.doodle.com/main.html). It's closed source. Let's make an open-source Doodle killer and call it Clockworks!
 
-We have a mailing list - if you're interested in helping design the app, or if you just want to hear more about what we're up to,  just blanche yourself onto **clockworks**.
+We have a mailing list - if you're interested in helping design the
+app, just [let one of the developers know](mailto:clockworks@mit.edu)
+and we'll add you to our mailing list, **clockworks**. Or if you just
+want to hear more about what we're up to, blanche yourself to the
+public list **clockworks-announce**.
 
-## Phase 1
+## Getting started
 
-Doodle clone. 100% duplication of Doodle functionality. Modifications to improve usability as necessary.
+Clockworks is in alpha phase; the most basic functions of the system are operational.
 
-What do people not like about Doodle?
+The best way to get started with Clockworks is to get yourself added to the project, grab a copy of the code, get it running on your laptop, and then poke around the source code.
 
-* Too much clicking
-* No obvious "I can, but would rather not"
+First, make sure you have Git installed on your system. You can grab it [here](http://git-scm.com/download). Verify that it installed by popping open a terminal and running **git --version**
 
-### Architecture
+Next, grab the source code.  If you have Debathena installed on your machine, you can clone the source using **git clone /mit/clockworks/clockworks.git**.  If not, you can use a dialup to get to the directory; **git clone ssh://username@linerva.mit.edu/mit/clockworks/clockworks.git** works well. If the clone succeeds, you will now have a folder named "clockworks".  **cd clockworks**
+
+Now, to install the application according to the instructions in the repository.
+
+Once you're running, here are some paths to take:
+
+1. Take a break and read some Django documentation to get a feel for the framework
+2. Browse through the todo list, pick a task that seems interesting, and start working on figuring out how to make it work
+3. Browse the source, fiddle with some variables, see what changes
+4. Decide what clockworks should look like, and take off
+
+
+## Development info
+
+Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
 
-* Python and Turbogears
-* Git repository
-* Use 15 minute timeslices to simplify interface (?)
 
 ### Principles
 
@@ -25,46 +39,22 @@ What do people not like about Doodle?
 * Extendibility
 * Open Source
 
-### Schema
-
-To be transferred from the whiteboard
-
-### Page Inventory
-
-List of "screens" in Doodle
-
-* Home page
-* Help pages (screencasts, interactive JavaScript, etc.)
-* Schedule event (should be one-page-able)
-  * General info (title, description, name, email)
-  * Days (calendar, should be AJAX)
-  * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
-  * Options (yes-no-ifneedbe, hidden poll, limit OKs)
-  * Poll created (admin, participant links)
-* View poll (timezone, name, times, information, functions)
-  * Edit entry (completely wiki!)
-  * Delete entry
-  * Add a comment
-  * Calendar export (both ways)
-  * File export (excel, pdf)
-  * Subscribe (atom, and then social feed services)
-  * Embed poll (iframe)
-* Admin poll (participation link)
-  * Edit poll (all original options)
-  * History
-  * Delete all participants/comments
-  * Delete poll
-
-## Phase 2
+## Potential Future Goals
 
 Doodle killer. Extra features. Pump it up.
 
+* Better UI
 * Integration
-  * Basic: integration with ICS calendars, GoogleCalenar, Exchange, and TechTime (for faculty)
+  * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
   * Advanced: integration with MIT's course schedules, Facebook
   * Would store persistent profiles of calendar data for users
 * Automatically prioritize and schedule events for you
 * Create mobile phone friendly version
+* View of a single calendar month should show "ghosts" of days from immediately previous and immediately past months, to fill out all the weeks.
+* Ability to convert Yes/No polls into Yes/Maybe/No polls (and vice versa)
+* When setting up a new poll, ability to copy-paste the times for any arbitrary row into any number of other arbitrary rows
+* "Generic week" function
+  * Indicates that the response is for a weekly meeting, not a specific date.
 
 ## Developers
 
@@ -72,4 +62,11 @@ Doodle killer. Extra features. Pump it up.
 * Paul Baranay
 * Edward Yang
 * Paul Weaver
+* Xavid Pretzer
+* Christian Ternus
+* David Benjamin
+* Paul W. Quimby
+* Andrew Farrell
 * <a href="mailto:clockworks@mit.edu">You?</a>
+
+