Added TL;DR section and replace 'build.sh' with paver.
diff --git a/GettingStarted.wiki b/GettingStarted.wiki index 19e57ca..1ec884a 100644 --- a/GettingStarted.wiki +++ b/GettingStarted.wiki
@@ -5,16 +5,58 @@ = Prerequisites = -[MelangeIntro Melange] is a web application written in python 2.5 ([http://www.python.org/download/releases/2.5.4/ install]) that runs on -[http://code.google.com/appengine/ Google App Engine]. For more setup information, take a look at CodingHintsAndTips. +[MelangeIntro Melange] is a web application written in python 2.5 ([http://www.python.org/download/releases/2.5.5/ install]) that runs on +[http://code.google.com/appengine/ Google App Engine]. + += TL;DR = + +You should read the text below, but if you want a quick refresher on how to get running, here's the TL;DR. + +== Setting up == + +If you do not yet have a melange directory set up, run the following commands. + +{{{ +hg clone http://soc.googlecode.com/hg/ melange && +cd melange && +python bootstrap.py && +bin/buildout && +scripts/gen_app_yaml.py local-devel && +bin/paver build --skip-pylint && +}}} + +== Running locally == + +If you want to run melange locally, run the following command + +{{{ +bin/gae_develop build +}}} + +== Deploying to your own instance == + +Assuming you have an AppEngine instance called 'your-melange-instance' + +{{{ +scripts/gen_app_yaml.py -f your-melange-instance && +bin/gae_develop build +}}} + +== Running the test suite == + +If you want to run the test suit, run the following + +{{{ +bin/run-tests +}}} = Checking Out the Code = -We are in the middle of switching repositories (from SVN to Mercurial/hg). So please be advised that currently we will try to keep SVN repository in sync with Mercurial, however in the long run we will only use our Mercurial repository. +We have switched from Subversion to Mercurial, so our svn repository is no longer updated. To check out Melange source code run the following command: -Using Mercurial repository (suggested!): +Using Mercurial repository: {{{ hg clone http://soc.googlecode.com/hg/ melange @@ -25,7 +67,7 @@ = Setting up your Client = Change directories into the working directory (the one created by checking out the code). Google App Engine requires a file `app.yaml` in the application directory. For now, you can create a dummy `app.yaml` file by running: {{{ -scripts/gen_app_yaml.py fake-application-name +scripts/gen_app_yaml.py local-devel }}} = Running the Code Locally = @@ -52,7 +94,7 @@ }}} -== Building With `scripts/build.sh` == +== Building With Paver == Because [http://code.google.com/p/soc/source/browse/#svn/trunk/app/tiny_mce Tiny MCE] @@ -65,26 +107,19 @@ launched with `thirdparty/google_appengine`, you still need to run a build script to produce these <tt>.zip</tt> files at least once. -To do this, you will need to execute the `build.sh` script found in the -`scripts` folder. On a UNIX system, in the `trunk/` directory of the working -copy, using shell commands, this can be done with something like: +To do this, you will need to execute the `bin/paver` script, using the following command {{{ -cd scripts/ -./build.sh +bin/paver build --skip-pylint }}} This script will create a `build/` directory at the same level as the `app/` directory (and the `scripts/` directory) in the `hg` working copy. -If you are using Windows, you will need to have Cygwin, and have it on your -path _before_ system binaries as the Windows `find` command conflicts with -the bash `find` command. You'll also need to explicitly prefix with `bash` -unless you have set up an association between sh and bash. == Deploying to Google App Engine == Once you have your application configured correctly and you have -executed the `build.sh` script found in the `scripts` folder, +executed the `paver` script found in the `bin` folder, you are ready to deploy your Melange image to your specific Google App Engine instance. @@ -93,7 +128,7 @@ to Google App Engine by using: {{{ -thirdparty/google_appengine/dev_appserver.py build +bin/gae_develop build }}} Once you are satisfied that `build/` contains everything needed, you can deploy