From: Edward Z. Yang Date: Tue, 21 Jul 2009 20:41:36 +0000 (-0400) Subject: add detailed quick start instructions X-Git-Url: https://sipb.mit.edu/gitweb.cgi/wiki.git/commitdiff_plain/b4b0166481d608ce6a754f31efc0ce5b24f0b71f add detailed quick start instructions --- diff --git a/projects/clockworks.mdwn b/projects/clockworks.mdwn index 5053cde..a60e8c5 100644 --- 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