Documented Eclipse setup.

This commit is contained in:
Achim D. Brucker 2018-04-08 17:32:04 +01:00
parent 0645a9264e
commit 1c558f89a3
1 changed files with 42 additions and 0 deletions

View File

@ -30,6 +30,48 @@ The ``DOF_mkroot`` command takes the same parameter as the standard
``mkroot`` command of Isabelle. Thereafter, the normal Isabelle
command for building documents can be used.
## Development Setup
Compilation using the provided ``build`` script, e.g.:
```console
cd converter
./build
```
This build script requires a basic Unix-environment as, e.g., provided
by Isabelle as well as a running Isabelle installation.
In addition, a maven setup is maintained that, e.g., can be imported
into Eclipse. This results in an Scala development environment that
supports the usual features of a modern IDE, e.g., Intellisense.
### Prerequisites (Eclipse Setup)
* Java 8
* Eclipse Oxygen, including
* [Scala IDE and Scalatest Runner (the latter is optional)](http://download.scala-ide.org/sdk/lithium/e47/scala212/stable/site)
* ["Maven for Scala" - Maven Integration for Eclipse](http://alchim31.free.fr/m2e-scala/update-site)
### Checkout
The converter is part of the Isabelle DOF repository:
```console
git clone https://git.logicalhacking.com/HOL-OCL/Isabelle_DOF.git
```
### Importing the Project into Eclipse
The project can be imported into a fresh Eclipse workspace using
`File -> Import -> Maven -> Existing Maven Projects`. Please select
the ``converter`` directory as parent directory. After the import, you
might need to resolve the dependencies using the maven integration of
Eclipse.
## Team
Main contacts:
* [Achim D. Brucker](http://www.brucker.ch/)
* [Burkhart Wolff](https://www.lri.fr/~wolff/)
## License
This project is licensed under a 2-clause BSD license.