From 201e0ee9785e907c9779c3ba72077f9432bdf46e Mon Sep 17 00:00:00 2001 From: Nelson Tavares de Sousa <ntd@informatik.uni-kiel.de> Date: Tue, 9 Dec 2014 21:35:15 +0100 Subject: [PATCH] set main page title to "Welcome | TeeTime" remodelled download page and main page --- pom.xml | 2 ++ src/changes/changes.xml | 29 +++++++++++--------- src/site/markdown/download.md | 50 ++++++++++++++++++++++++++--------- src/site/markdown/index.md | 24 +++++++++-------- src/site/site.xml | 3 ++- 5 files changed, 71 insertions(+), 37 deletions(-) diff --git a/pom.xml b/pom.xml index fb5f8ca0..0e5fbc7e 100644 --- a/pom.xml +++ b/pom.xml @@ -76,11 +76,13 @@ <groupId>org.hamcrest</groupId> <artifactId>hamcrest-core</artifactId> <version>1.3</version> + <scope>test</scope> </dependency> <dependency> <groupId>org.hamcrest</groupId> <artifactId>hamcrest-library</artifactId> <version>1.3</version> + <scope>test</scope> </dependency> <dependency> <groupId>org.slf4j</groupId> diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 9cd8471f..7ca35aac 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -1,14 +1,19 @@ <document xmlns="http://maven.apache.org/changes/1.0.0" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/xsd/changes-1.0.0.xsd"> - <properties> - <title>Release notes</title> - </properties> - <body> - <release version="1.0-SNAPSHOT" date="15.12.2014" description="Preparing initial Release"> - <action dev="ntd" type="add" issue="66"> - Created a new site to promote TeeTime. - </action> - </release> - </body> + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/xsd/changes-1.0.0.xsd"> + <properties> + <title>Release notes</title> + </properties> + <body> + <release version="Snapshot" date="Daily basis" description="Unstable preview of oncoming versions"> + <action dev="ntd" type="add" issue="66"> + Created a new site to promote TeeTime. + </action> + </release> + <release version="1.0" date="Soon" description="Initial release"> + <action type="add"> + Initial release of TeeTime + </action> + </release> + </body> </document> \ No newline at end of file diff --git a/src/site/markdown/download.md b/src/site/markdown/download.md index a59f1817..dfcedd33 100644 --- a/src/site/markdown/download.md +++ b/src/site/markdown/download.md @@ -2,21 +2,43 @@ There are several ways to get TeeTime. Choose the best one for you. -## Maven repository +## Latest stable -To get TeeTime as Dependency for your project, simply add following lines to your pom.xml; +There are two simple ways to add TeeTime to your own project. -#### Latest stable release +>Please note, that TeeTime's first official release isn't published yet. You can switch to the snapshot release or wait a couple of days. We are looking forward, to release 1.0 still this month. + +#### As dependency + +TeeTime is available through Maven's central repository. + +If you use Maven, simply add following lines to your pom.xml: ```xml <dependency> <groupId>net.sourceforge.teetime</groupId> <artifactId>teetime</artifactId> - <version>1.0-SNAPSHOT</version> + <version>1.0</version> </dependency> ``` -#### Snapshot +Dependency informations for other project management tools can be found [here](dependency-info.html). Please make sure, your tool uses Maven's central repository. Help on how to add it, can be found [here](http://central.sonatype.org/pages/consumers.html). + +#### Binaries and sources + +The latest TeeTime release can be downloaded directly from [Sourceforge](https://sourceforge.net/projects/teetime/files/latest/download). If you also want to download the source and/or JavaDoc, you can also get a summary of available files on [Sourceforge](https://sourceforge.net/projects/teetime/files/) + +## Snapshot + +TeeTime is built upon a daily basis. All these nightly builds are accessible to the public. + +Please do not forget, that this releases are not intended for daily use. These builds may be unstable. + +#### As dependency + +All snapshot builds will be deployed to Sonatype's snapshot repository. + +To download these builds, add following lines to your project's pom.xml: ```xml <dependency> @@ -26,17 +48,19 @@ To get TeeTime as Dependency for your project, simply add following lines to you </dependency> ``` -Dependency informations for other project management tools can be found [here](dependency-info.html) - -## Source +If you did not add the Sonatype snapshot repository yet to your pom.xml, add also following lines to it, as otherwise Maven will not be able to find the needed artifacts: -You can also download the source code. - -#### Latest stable release +```xml +<repositories> + <repository> + <id>sonatype.oss.snapshots</id> + <url>https://oss.sonatype.org/content/repositories/snapshots/</url> + </repository> +</repositories> +``` -The latest TeeTime release can be downloaded from [Sourceforge](https://sourceforge.net/projects/teetime/files/latest/download). -#### Snapshot +#### Binaries and sources All nightly builds can be found on [Sonatype's repository](https://oss.sonatype.org/content/repositories/snapshots/net/sourceforge/teetime/teetime/) or our [CI Server](https://build.se.informatik.uni-kiel.de/jenkins/view/TeeTime/job/teetime-nighly-release/lastSuccessfulBuild/artifact/target/). diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md index c73e3bd2..cf2f9f2e 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/index.md @@ -18,16 +18,10 @@ Predefined stages are provided within the source code. You can immediatly start --- -##Check again later... - -..., as this page and the whole project is still WIP. - -The first stable release will be published soon. For more informations visit: https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime - -<!---  TeeTime Logo --> ## What is it? +<!---  TeeTime Logo --> TeeTime is a Pipes-And-Filter-Framework for Java. It provides various features, which will bring you to the next level of analysis programming, such like: @@ -48,14 +42,22 @@ TeeTime is available in many ways. If your projects use Maven, just add followin <dependency> <groupId>net.sourceforge.teetime</groupId> <artifactId>teetime</artifactId> - <version>1.0-SNAPSHOT</version> + <version>1.0</version> </dependency> ``` -To get the source code or the plain jar, take a look at the download section. +>TeeTime's first official release is not published yet. For more information, see [download](download.html). + +To get the source code or the plain jar, take a look at the [download](download.html) section. + +## How to use it + +To make working with TeeTime as pleasant and efficient as possible, this homepage provides various tools for you, which explain TeeTime's functions. + +You can take a closer look at: -## Concurrency-aware +- [TeeTime's Wiki](https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/wikis/home). -TeeTime takes care of a parallel execution of stages. You do not need to think about anything, as TeeTime creates and manages all threads, needed by your analysis. +- [API Documentation](apidocs/index.html). \ No newline at end of file diff --git a/src/site/site.xml b/src/site/site.xml index f711c546..d904344e 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -81,8 +81,9 @@ <breadcrumbs>false</breadcrumbs> <sections> <carousel /> - <columns>2</columns> + <columns>3</columns> </sections> + <shortTitle>Welcome</shortTitle> </index> <license> <highlightJs>false</highlightJs> -- GitLab