add detailed quick start instructions

[wiki.git] / projects / clockworks.mdwn

diff --git a/projects/clockworks.mdwn b/projects/clockworks.mdwn
index aa088c95ea12a1f6b99fc54775e3eb6ed88225ad..a60e8c5850a34a81ab885a43f252c161d3d29fa3 100644 (file)
--- a/projects/clockworks.mdwn
+++ b/projects/clockworks.mdwn
@@ -8,6 +8,22 @@ 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**.
 
+## Getting started
+
+Clockworks is in pre-pre-alpha phase; most of the functionality hasn't been done yet.
+
+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.  We also have a Hiveminder project with bite-sized tasks that you can work on (ping a project maintainer to get invited.)
+
+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**
+
+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.  Assuming that you have a reasonable version of Python on your system, running **./nosudo-virtualenv.sh** should set up the environment.  If it succeeds, you'll see the help output for a command named paster.
+
+Run the application by changing into your environment with **source tg2env/bin/activate** and then typing **paster serve development.ini**. And voila; a very boilerplate TurboGears install should be facing you at http://localhost:8080
+
+The stage is yours.
+
 ## Development info
 
 Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/clockworks.git
@@ -106,6 +122,7 @@ List of "screens" in Doodle
   * **/myclockworks/changePassword**
   * **/myclockworks/editInformation**
   * **/myclockworks/delete**
+  * Note: Doodle functions by creating two links per event: one for the public and one for administrator, but anyone can follow either link if they know what it is
 
 ## Phase 2
 
@@ -118,6 +135,11 @@ Doodle killer. Extra features. Pump it up.
   * 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
 
@@ -127,4 +149,5 @@ Doodle killer. Extra features. Pump it up.
 * Paul Weaver
 * Xavid Pretzer
 * Christian Ternus
+* David Benjamin
 * <a href="mailto:clockworks@mit.edu">You?</a>