Commit d600d915 authored by Christian Meyer's avatar Christian Meyer
Browse files

Readme.md: added infos about properties and servers

    updated deployment / publishing sections
parent ffc4f4bf
......@@ -25,15 +25,28 @@ Credentials are stored in `~/.gradle/gradle.encrypted.properties`. This will sav
For more information about the credentials plugin visit https://github.com/etiennestuder/gradle-credentials-plugin.
## Maven Repository
There is a maven repository on the dochost server within the `maven2/` subdirectory. Libraries are stored there and fetched by Gradle when they are required. See the [Publishing entry](#publishing) for more info.
## Servers
There are two servers available:
* Public: https://dochost.leibniz-zmt.de/
* Internal: http://dochost.intra.zmt/ (only accessible in ZMT intranet)
Both of them have a Maven Repository within the `maven2/` subdirectory. Libraries are stored there and fetched by Gradle when they are required. See the [publishing entry](#publishing) for more info. The servers are also used for [javadoc](#javadoc) and [distribution deployment](#deployment).
## Properties
There are several custom properties used to control the build process. For more information on how to set properties in gradle, consult https://docs.gradle.org/current/dsl/org.gradle.api.Project.html and https://docs.gradle.org/current/userguide/build_environment.html. Only the most important ones are listed here.
* `simClassName`: The name of the simulation class. Defaults to project name with the first letter upper case. Used in run scripts. The package can be omitted if `sim.engine`.
* `launcherDependency`: The launcher dependency compatible with the project. Defaults to `de.zmt:zmt-launcher:latest.release`.
* `de.zmt.gradle.dochost.deployPublic`: If set `true` [javadoc](#javadoc) and [distributions](#deployment) are put to the public server. Otherwise, the internal one is used. Defaults to `false`.
* `de.zmt.gradle.dochost.publishPublic`: If set `true`, libraries are [published](#publishing) to the public server. Otherwise the internal one is used. Defaults to `true`.
## Javadoc
Javadoc files of the current project can be build and stored on dochost's `javadoc/` subdirectory:
```
./gradlew deployJavadoc
```
Only the recent version is stored and outdated files will be overwritten.
Only the recent version is stored and outdated files will be overwritten. The [property](#properties) `de.zmt.gradle.dochost.deployPublic` is used to select the server.
# Simulations
To make your simulation build with the zmt-build add the following to your `build.gradle` file:
......@@ -41,12 +54,12 @@ To make your simulation build with the zmt-build add the following to your `buil
buildscript {
repositories {
maven {
url "http://dochost.intra.zmt/maven2/"
url 'https://dochost.leibniz-zmt.de/maven2/'
}
}
dependencies {
classpath 'de.zmt:zmt-build:1+'
classpath 'de.zmt:zmt-build:latest.release'
}
}
apply plugin: 'de.zmt.simulation'
......@@ -65,6 +78,7 @@ Distributions can be uploaded to the `dist/` subdirectory on 'dochost' server:
```shell
./gradlew deployZip
```
The [property](#properties) `de.zmt.gradle.dochost.deployPublic` is used to select the server.
## Running
The launcher is accessible via the 'run' task. Arguments can be supplied with the 'args' property.
......@@ -101,4 +115,4 @@ Libraries can be published to dochost:
```
./gradlew publish
```
After that, they will be accessible by Gradle when required.
\ No newline at end of file
After that, they will be accessible by Gradle when required. The [property](#properties) `de.zmt.gradle.dochost.publishPublic` is used to select the server.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment