Removed installation instructions, as they are now in the main README.md.

This commit is contained in:
Achim D. Brucker 2018-06-12 23:29:04 +01:00
parent 03474d69ff
commit 14b7eb2a57
1 changed files with 0 additions and 65 deletions

View File

@ -3,71 +3,6 @@
This directory contains the DOF-plugin for Isabelle's
document generation system.
## Installation
In most case, the DOF-plugin can be installed as follows:
```console
foo@bar:~$ ./install
```
If a specific Isabelle version should be used (i.e., not the default
one), the full path to the ``isabelle`` command needs to be passed as
argument to the ``install`` script:
```console
foo@bar:~$ ./install /usr/local/Isabelle2016-1/bin/isabelle
```
The DOF-plugin will be installed in the Isabelle user directory
(the exact location depends on the Isabelle version).
## Usage
The DOF-plugin provides an alternative to Isabelle's ``mkroot`` command.
Isabelle projects that use DOF need to be created using
```console
foo@bar:~$ isabelle DOF_mkroot -d
```
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.
Using the ``-o`` option, different ontology setups can be
selected and using the ``-t`` option, different LaTeX setups
can be selected (use ``-h`` to obtain a list of all installed setups):
```console
foo@bar:~$ isabelle DOF_mkroot -h
Usage: isabelle DOF_mkroot [OPTIONS] [DIR]
Options are:
-h print this help text and exit
-d enable document preparation
-n NAME alternative session name (default: DIR base name)
-o ONTOLOGY (default: core)
Available ontologies:
* cenelec_50126
* core
* mathex
* scholarly_paper
-t TEMPLATE (default: DEFAULT_TEMPLATE)
Available document templates:
* lncs
* scrreprt
Prepare session root DIR (default: current directory).
```
For example,
```console
foo@bar:~$ isabelle DOF_mkroot -d -o scholarly_paper -t lncs
```
creates a setup using the scholarly_paper ontology and Springer's
LNCS LaTeX class as document class. Note that the generated setup
does not include the actual ``llncs.cls`` file. This is due to
license restrictions. You need to obtain the file from Springer's
website and either copy it in you ``texmf`` directory or the ``root``
folder. In the latter case, you also need to add it in the ``ROOT`` file
as dependency.
## Development Setup
Compilation using the provided ``build`` script, e.g.: