Skip to content

Installation

Jump to bottom
pja35 edited this page Nov 14, 2017 · 1 revision

Everything should work on all platforms but we only give step by step instructions for Ubuntu (and notes for Windows).

I. Setting up your programming environment

This section explains how to configure your programming environment to set up the GOOL system. Some steps are important for the whole system whereas others are only required by a specific input/output language and can be left out, depending on your usage of the GOOL System.

1. General setup

  • Install Git from Debian packages:
sudo apt-get install git
  • Install Java8 from Debian packages:
sudo apt-get install openjdk-8-source openjdk-8-jdk

Notes for Windows :

2. C# output

  • Install C# from Debian packages (see official mono site):
sudo apt-get install mono-devel mono-mcs

Notes for Windows :

  • Download the last .NET Framework from the Microsoft website and install it.
  • Add the install directory in your Windows Path. For example : C:\Windows\Microsoft.NET\Framework64\v4.0.30319

3. C++ output

  • Install C++ from Debian packages:
sudo apt-get install g++
  • Install C++/Boost libraries from Debian packages:
sudo apt-get install libboost-all-dev
  • Install C++/Eclipse plug-in:
sudo apt-get install eclipse-cdt

Notes for Windows :

  • Download MinGW from http://www.mingw.org/ and install it.
  • Add the bin folder to your Windows Path. For example : C:\MinGW\bin
  • Download boost from http://www.boost.org/ and place the boost folder at the root directory of your Git project. For example : C:\Users\MyUserName\git

4. Python output

The python output is given in python 2.7 but compatible with python 3. To compile it do use the standard python 2.7 compiler provides with your OS. You can also use the fully integrated python solution provided by Anaconda.

5. Clone the repository

After setting up your programming environment, you can clone the GOOL repository locally:

git clone https://github.com/librecoop/GOOL.git

II. Checking paths to external compilers

Within the gool directory you will find the following directories:

  • src: contains all gool java sources.
  • tests: default GOOL translation directories for the manual translations (see Usage).
  • lib: GOOL dependencies.
  • Elements: front-end js and css files.
  • gradle and .settings: gradle wrapper directories.

In the src directory, you will find two different kind of sources. The test sources within src/test and the main sources within the src/main directory.

In the src/main/ressources directory you should find two critical files for GOOL:

  • gool.properties.example contains the typical configuration properties.
  • gool.properties contains your configuration.

If gool.properties does not exist, rename the typical configuration file to create it.

III. Testing the project

To launch the GOOL tests, from the root directory, launch:

./gradlew test

All tests must pass. If not you can access the test results in the file build/reports/tests/index.html, look what is wrong and if it does not help do not hesitate to open an issue on the project.

Many things has not been systematically tested in GOOL as you can see in the tests coverage result in the file /build/jacocoHtml/index.html. Any help is welcome!

Clone this wiki locally