Describe -c 3down
[wiki.git] / projects / clockworks.mdwn
index 5053cde0864307f6f6de638b7076874821e360d1..61632494d1c148efab41f023441b459f3ba9b1ad 100644 (file)
@@ -8,6 +8,30 @@ 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 --reload development.ini**. And voila; a very boilerplate TurboGears install should be facing you at http://localhost:8080
+
+If these steps fail (which happens on some configurations of OS X and almost invariably on Windows), talk to us and we can get you set up with a copy running on scripts.mit.edu or xvm.mit.edu.
+
+Once you're running, here are some paths to take:
+
+1. Take a break and read some TurboGears 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