Sin descripción

Oliver Gierke 02a624bb5d #249 - Prepare next development iteration. hace 5 años
doc 77c5b1abda #5 - Added Buildsystem Maven to documentation. hace 10 años
etc 22d0c2dfa1 #25 - Overhauled domain code. hace 10 años
src ba6a50c19e #224 - Polishing. hace 5 años
.gitignore 1ddf413010 #229 - Add .factorypath to .gitignore. hace 6 años
.travis.yml 7305a004ec #238 - Define custom Maven execution for Travis. hace 6 años
LICENSE ccc8e807d9 #169 - Added license file to project root. hace 7 años
Salespoint.sonargraph 5450ed1889 #150 - Updated Sonargraph architecture description. hace 8 años
lombok.config 9cd370f13f #9 - Introduced simplified Quantity abstraction. hace 9 años
pom.xml 02a624bb5d #249 - Prepare next development iteration. hace 5 años
readme.adoc d60ee6da8d #187 - Added build status image to the README. hace 7 años

readme.adoc

# Salespoint Framework

image:https://travis-ci.org/st-tu-dresden/salespoint.svg?branch=master["Build Status", link="https://travis-ci.org/st-tu-dresden/salespoint"]

## 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`.

## Release

1. Make sure all tickets are closed, except the release one.
2. Tweak `ChangelogCreator` (in `src/test/java`) to point to the milestone to be released. Run the creator. Copy console output into `src/main/asciidoc/site/changelog.adoc`.
3. Commit as `#?? - Prepare release $version.`.
4. Run `mvn release:prepare`.
5. Edit commits to match commit message format, re-create tag.
6. Push changes & tag.
7. Check out tag.
8. Run `mvn clean deploy site:deploy -Prelease -DskipTests`.