README
changeset 2 76d160eba8d4
child 3 efa883909c06
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Jun 02 16:27:06 2009 +0100
     1.3 @@ -0,0 +1,47 @@
     1.4 +Setup and Build the Template
     1.5 +============================
     1.6 +
     1.7 +This is fairly easy. First, clone the project template repository and step
     1.8 +into the dir, as follows (you've probably done it already if you read this
     1.9 +file).
    1.10 +
    1.11 +$ hg clone http://lemon.cs.elte.hu/hg/lemon-project-template myproject
    1.12 +$ cd myproject
    1.13 +
    1.14 +As you probably want to use LEMON in your project, you will need it
    1.15 +too. For this you have to options. You can either install is somewhere
    1.16 +or use a local copy of lemon dedicated to your project. This later
    1.17 +option is especially usefull if you also modify/develop LEMON along
    1.18 +with your project, or want to use a specific version.
    1.19 +
    1.20 +Use a preinstalled version.
    1.21 +
    1.22 +    See http://lemon.cs.elte.hu/trac/lemon/wiki/InstallGuide for
    1.23 +    instructions on how to install LEMON. If you installed it to a
    1.24 +    non-standard place, you must let CMAKE know where to find it in
    1.25 +    the LEMON_ROOT_DIR config variable.
    1.26 +
    1.27 +Use LEMON as a subproject.
    1.28 +
    1.29 +    Just simply coping the lemon source code into the 'lemon' subdir
    1.30 +    will do the job. Namely, you can either extract a release tarball
    1.31 +
    1.32 +    $ wget http://lemon.cs.elte.hu/pub/sources/lemon-1.1.tar.gz
    1.33 +    $ tar xzf lemon-1.1.tar.gz
    1.34 +    $ mv lemon-1.1 lemon
    1.35 +
    1.36 +    or - even better - you can check out the mercurial LEMON repository
    1.37 +
    1.38 +    $ hg clone http://lemon.cs.elte.hu/hg/lemon-main lemon
    1.39 +
    1.40 +Then run CMAKE to create the makefiles as usual.
    1.41 +
    1.42 +$ mkdir build
    1.43 +$ cd build
    1.44 +$ cmake-gui ..
    1.45 +
    1.46 +Setup Your Own Project
    1.47 +======================
    1.48 +
    1.49 +Edit CMakeLists.txt to change the name of the project and the source
    1.50 +files. Simply follow the instructions in CMakeLists.txt.