Changes between Version 61 and Version 62 of Be a CIVL developer


Ignore:
Timestamp:
03/02/23 17:05:35 (3 years ago)
Author:
Alex Wilton
Comment:

Removed references to Windows since it is now clear we don't support it. Also fixed a couple of instructions that became outdated.

Legend:

Unmodified
Added
Removed
Modified

  • Be a CIVL developer

    v61 v62  
    2727  1. Download the file found at [http://vsl.cis.udel.edu/lib/tools/vsl_depend].
    2828  1. Unzip the `.tgz` so that you end up with a folder with a name of the form `vsl-X.XX`.
    29   1. Pick somewhere in your filesystem to move this folder. On Unix systems a good choice is `/opt`. On Windows a good choice is `C:\Program Files`. Note that you may need to use `sudo` on Unix or use Administrator permissions on Windows to perform this move depending on where you choose to place this folder. \\\\
     29  1. Pick somewhere in your filesystem to move this folder. A good choice is `/opt`. Note that you may need to use `sudo`. \\\\
    30301. Install Eclipse IDE for Java Developers from here: [https://www.eclipse.org/downloads/packages/installer] \\\\
    31311. Install Subversive for Eclipse using these instructions (paying attention to our notes below): [https://www.eclipse.org/subversive/installation-instructions.php]
    3232  * ''Phase 1 notes:''
    33     * When selecting which components to install only "Subversvie > Subversive SVN Team Provider" is required.
     33    * When selecting which components to install only "Subversive > Subversive SVN Team Provider" is required.
    3434  * ''Phase 2 notes:''
    3535    * There is a comment that a dialog automatically displays after rebooting but it is not our experience that this actually happens. So if it doesn't for you then just follow the instructions they have just below that comment for manually installing the SVN connectors. It will be a near identical process to the installation done in Phase 1.
    … …  
    5353    * `dev.civl.sarl` \\\\
    54541. You probably will want to change the package presentation to the hierarchical view since it makes navigating the code much easier. Click the three vertical dots at the top right of the Package Explorer window (where your projects are) and then press "Package Presentation > Hierarchical". \\\\
    55 1. Open up the file `dev.civl.com/build_default.properties`. If the value of `root.parent` does not match the absolute path to the containing folder of the VSL dependencies folder, `vsl-X.XX`, that you downloaded earlier then perform the following nested instructions:
     551. Open up the file `dev.civl.com/build_default.properties`. If the value of `root` does not match the absolute path to the VSL dependencies folder, `vsl-X.XX`, that you downloaded earlier then perform the following nested instructions:
    5656  1. Close `build_default.properties` and then make a copy of it (still in `dev.civl.com`) called `build.properties`. Do not delete `build_default.properties` since this is tracked by SVN.
    57   1. Open up `build.properties` and replace the value of `root.parent` with the absolute path to the containing folder of `vsl-X.XX`. If you are on Windows, you must replace backslashes `\` with forward slashes `/`. For example, if you are on Windows and your path to `vsl-X.XX` looks like `C:\Program Files\vsl-X.XX`, then the value of `root.parent` will be `C:/Program Files`.
     57  1. Open up `build.properties` and replace the value of `root` with the absolute path to `vsl-X.XX`, replacing `X.XX` with `${civlversion}`.
    5858  1. Save and close the file. \\\\
    59591. Next we will point Eclipse to where the dependencies for CIVL are.
    … …  
    7272    * `ECLIPSE_WORKSPACE` should be the path to your Eclipse workspace folder.
    7373    * `VSL_DEPS` should be the path to your `vsl-X.XX` dependencies folder.
    74   1. Somewhere on your system, create a plain text file named `civl` (if on windows, name it `civl.ps1` since this will be a powershell script) and copy-paste one of the following snippets into this file, depending on what system you are using:
    75     * ''Unix:''
     74  1. Somewhere on your system, create a plain text file named `civl` and copy-paste the following:
    7675    {{{
    7776#!/bin/sh
    78 java -cp $ECLIPSE_WORKSPACE/dev.civl.abc/bin:$ECLIPSE_WORKSPACE/dev.civl.gmc/bin:$ECLIPSE_WORKSPACE/dev.civl.mc/bin:$ECLIPSE_WORKSPACE/dev.civl.sarl/bin:$VSL_DEPS/mods/antlr3/antlr3runtime.jar:$VSL_DEPS/mods/antlr4/antlr4runtime.jar dev.civl.mc.CIVL $@
     77java -cp $ECLIPSE_WORKSPACE/dev.civl.com -p $ECLIPSE_WORKSPACE/dev.civl.abc:$ECLIPSE_WORKSPACE/dev.civl.gmc:$ECLIPSE_WORKSPACE/dev.civl.mc:$ECLIPSE_WORKSPACE/dev.civl.sarl:$VSL_DEPS/mods/antlr3:$VSL_DEPS/mods/antlr4 -m dev.civl.mc/dev.civl.mc.CIVL $@
    7978    }}}
    80     * ''Windows:''
    81     {{{
    82 java -cp "$ENV:ECLIPSE_WORKSPACE\dev.civl.abc\bin;$ENV:ECLIPSE_WORKSPACE\dev.civl.gmc\bin;$ENV:ECLIPSE_WORKSPACE\dev.civl.mc\bin;$ENV:ECLIPSE_WORKSPACE\dev.civl.sarl\bin;$ENV:VSL_DEPS\mods\antlr3\antlr3runtime.jar;$ENV:VSL_DEPS\mods\antlr4\antlr4runtime.jar" dev.civl.mc.CIVL $args
    83     }}}
    84   1. If on Unix then you must make it executable. You can use the command `chmod ugo+x civl`.
     79  1. You must make it executable. You can use the command `chmod ugo+x civl`.
    8580  1. Move this file to somewhere on your `PATH`.
    8681  1. Run `civl help` from the command line to ensure that it worked. You should get a long list of command line options that CIVL accepts. \\\\