Add note about git with shared checkouts
[wiki.git] / projects / clockworks.mdwn
index 7ec1f1ed821e1a673314e18fba40233aab3be23b..4ce15fbbdf86b0dbcdbcc5d0018d2dfa73239fb8 100644 (file)
@@ -1,92 +1,86 @@
 [[!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!
+## Summary
+So originally we were thinking, "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!" More recently, we've been considering what we can do to help schedule things around MIT.
 
-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**.
 
-## Development info
-
-Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
+## State & History
+Clockworks is in alpha phase; the most basic functions of the system are operational. A user can:
 
-## Phase 1
+* Make an account via the online registration system
+* Login to the web interface to enable poll modifications
+* Create a every simple poll
+* View poll
+* Vote in a poll
 
-Doodle clone. 100% duplication of Doodle functionality. Modifications to improve usability as necessary.
+The current implementation is in Django. There was an older Clockworks pre-pre-alpha implementation in TurboGears. 
 
-What do people not like about Doodle?
+## Getting started
 
-* Too much clicking
-* No obvious "I can, but would rather not"
+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.
 
-### What to do?
+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**
 
-* [Configure](http://docs.turbogears.org/1.0/Configuration?action=show&redirect=1.0%2FGettingStarted%2FConfiguration) the default TurboGears scaffolding
-* Work through the [TurboGears tutorial](http://docs.turbogears.org/1.0/Wiki20/Page1) (the tutorial seems to focus on SQLObject, which is not necessarily the best thing. Maybe someone can find some better docs?)
-* Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). Also, make sure SQLAlchemy is being used
-* Learn SQLAlchemy
-* Make sure the default scaffolding works on Scripts (this includes running TurboGears as CGI). Any work done here should be considered for a TurboGears auto-installer, the equivalent of tgsetup) (**ezyang**)
-* Write a .gitignore file for generated/not versionable items
-* Get friendly URLs working
-* Learn TurboGear's templating interface (would like XSLT, but I don't think anyone else will like that)
-* <del>Setup a zephyrbot that watches the repository</del>
+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**
 
-### Architecture
+Now, to install the application according to the instructions in the repository.
 
-* Python and Turbogears
-* Git repository
-* Use 15 minute timeslices to simplify interface (?)
-* AJAX (?)
+Once you're running, here are some paths to take:
 
-### Principles
+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
 
-* Simplicity
-* Extendibility
-* Open Source
 
-### Schema
+## Development info
 
-To be transferred from the whiteboard
+Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
 
-### Page Inventory
+The repo contains a Django project.
 
-List of "screens" in Doodle
+## Some Simpler Future Steps:
 
-* 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
+* Create a groups mechanic
+* Enable the sending of polls to groups
+* Enable poll configurations other than the current default
+* Enable users to manage their polls centralls
+* Add a user homepage
+* Add a homepage
 
-## Phase 2
+## Potential Future Dream Goals
 
 Doodle killer. Extra features. Pump it up.
 
+* Better UI
 * Integration
   * 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
 
+* Paul W. Quimby
+* Andrew Farrell
 * Geoffrey Thomas
 * Paul Baranay
 * Edward Yang
 * Paul Weaver
+* Xavid Pretzer
+* Christian Ternus
+* David Benjamin
 * <a href="mailto:clockworks@mit.edu">You?</a>
+
+