Oliver Gierke
77eda03e37
#127 - Prepare next development iteration.
|
%!s(int64=9) %!d(string=hai) anos | |
|---|---|---|
| doc | %!s(int64=10) %!d(string=hai) anos | |
| etc | %!s(int64=10) %!d(string=hai) anos | |
| src | %!s(int64=9) %!d(string=hai) anos | |
| .gitignore | %!s(int64=10) %!d(string=hai) anos | |
| Salespoint.sonargraph | %!s(int64=9) %!d(string=hai) anos | |
| lombok.config | %!s(int64=9) %!d(string=hai) anos | |
| pom.xml | %!s(int64=9) %!d(string=hai) anos | |
| readme.adoc | %!s(int64=10) %!d(string=hai) anos |
readme.adoc
# Salespoint Framework
## Prerequisites
- Java 8
- Git
- Maven 3.x
## Building the project
.Building the project
[source, bash]
----
$ git clone https://github.com/st-tu-dresden/salespoint
$ cd salespoint
$ mvn clean install
----
## Documentation
The reference documentation is written in Asciidoc and built using Asciidoctor. The main documentation source file is located in `src/main/asciidoc`.
To build the reference documentation simply run `mvn generate-resources` on the command line. This generates the following HTML files:
* the Salespoint website in `target/generated-docs/index.html`.
* the Salespoint reference in `target/generated-docs/salespoint-reference.html`.
## Deployment
To deploy artifacts to the salespoint repository, simply run `mvn clean deploy`. This requires your `settings.xml` (located in `~/.m2`) to contain a server defintion with the credentials to access the Salespoint server via SFTP:
[source, xml]
----
salespoint
…
…
----
To deploy the website and reference documentation, run `mvn site:deploy`.
## Prerequisites
- Java 8
- Git
- Maven 3.x
## Building the project
.Building the project
[source, bash]
----
$ git clone https://github.com/st-tu-dresden/salespoint
$ cd salespoint
$ mvn clean install
----
## Documentation
The reference documentation is written in Asciidoc and built using Asciidoctor. The main documentation source file is located in `src/main/asciidoc`.
To build the reference documentation simply run `mvn generate-resources` on the command line. This generates the following HTML files:
* the Salespoint website in `target/generated-docs/index.html`.
* the Salespoint reference in `target/generated-docs/salespoint-reference.html`.
## Deployment
To deploy artifacts to the salespoint repository, simply run `mvn clean deploy`. This requires your `settings.xml` (located in `~/.m2`) to contain a server defintion with the credentials to access the Salespoint server via SFTP:
[source, xml]
----
salespoint
…
…
----
To deploy the website and reference documentation, run `mvn site:deploy`.