Changes between Version 59 and Version 60 of Be a CIVL developer

Timestamp:

02/24/23 11:22:55 (3 years ago)

Author:

Alex Wilton

Comment:

Updated section on running CIVL to support Windows

Be a CIVL developer

@@ -72 +72 @@
     * `ECLIPSE_WORKSPACE` should be the path to your Eclipse workspace folder.
     * `VSL_DEPS` should be the path to your `vsl-X.XX` dependencies folder.
-  1. Somewhere on your system, create a plain text file named `civl` containing exactly the following two lines: 
-  {{{
+  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:
+    * ''Unix:''
+    {{{
 #!/bin/sh
-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 $@ 
-  }}}
-  1. Make it executable with the command `chmod ugo+x civl`.
+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 $@
+    }}}
+    * ''Windows:''
+    {{{
+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
+    }}}
+  1. If on Unix then you must make it executable. You can use the command `chmod ugo+x civl`.
   1. Move this file to somewhere on your `PATH`.
   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. \\\\