Skip to content
Snippets Groups Projects
Commit 27bbbe15 authored by Christian Wulf's avatar Christian Wulf
Browse files

Merge branch 'site' into 'master'

Site

See merge request !19
parents 519fa456 2e8532b8
No related branches found
No related tags found
No related merge requests found
Showing
with 368 additions and 3 deletions
[submodule "src/site/markdown/wiki"]
path = src/site/markdown/wiki
url = gitlab@build.se.informatik.uni-kiel.de:chw/teetime.wiki.git
...@@ -23,7 +23,16 @@ ...@@ -23,7 +23,16 @@
<java.version>1.6</java.version> <java.version>1.6</java.version>
</properties> </properties>
<issueManagement>
<system>GitLab</system>
<url>https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/issues/</url>
</issueManagement>
<distributionManagement> <distributionManagement>
<site>
<id>teetime.sf.net</id>
<url>scp://shell.sourceforge.net/home/project-web/teetime/htdocs</url>
</site>
<snapshotRepository> <snapshotRepository>
<id>teetime-deployment</id> <id>teetime-deployment</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url> <url>https://oss.sonatype.org/content/repositories/snapshots</url>
...@@ -55,8 +64,14 @@ ...@@ -55,8 +64,14 @@
<connection>scm:git:https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime.git</connection> <connection>scm:git:https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime.git</connection>
<developerConnection>scm:git:ssh://gitlab@build.se.informatik.uni-kiel.de:chw/teetime.git</developerConnection> <developerConnection>scm:git:ssh://gitlab@build.se.informatik.uni-kiel.de:chw/teetime.git</developerConnection>
<url>https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/</url> <url>https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/</url>
<tag>teetime-1.0</tag>
</scm> </scm>
<ciManagement>
<system>Jenkins</system>
<url>https://build.se.informatik.uni-kiel.de/jenkins/view/TeeTime/</url>
</ciManagement>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>junit</groupId> <groupId>junit</groupId>
...@@ -101,7 +116,12 @@ ...@@ -101,7 +116,12 @@
<build> <build>
<plugins> <plugins>
<!-- Release plugin -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.1</version>
</plugin>
<!-- we want JDK 1.6 source and binary compatibility --> <!-- we want JDK 1.6 source and binary compatibility -->
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
...@@ -194,7 +214,9 @@ ...@@ -194,7 +214,9 @@
<executions> <executions>
<execution> <execution>
<phase>test</phase> <phase>test</phase>
<goals><goal>check</goal></goals> <goals>
<goal>check</goal>
</goals>
<configuration> <configuration>
<configLocation>${project.basedir}/conf/quality-config/cs-conf.xml</configLocation> <configLocation>${project.basedir}/conf/quality-config/cs-conf.xml</configLocation>
<includeTestSourceDirectory>true</includeTestSourceDirectory> <includeTestSourceDirectory>true</includeTestSourceDirectory>
...@@ -254,12 +276,59 @@ ...@@ -254,12 +276,59 @@
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.3</version>
<dependencies>
<!-- for using markdown syntax -->
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-module-markdown</artifactId>
<version>1.3</version>
</dependency>
<!-- add support for ssh/scp -->
<dependency>
<groupId>org.apache.maven.wagon</groupId>
<artifactId>wagon-ssh</artifactId>
<version>1.0</version>
</dependency>
<!-- skin -->
<dependency>
<groupId>lt.velykis.maven.skins</groupId>
<artifactId>reflow-velocity-tools</artifactId>
<version>1.1.1</version>
</dependency>
<!-- Reflow skin requires Velocity >= 1.7 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity</artifactId>
<version>1.7</version>
</dependency>
</dependencies>
</plugin>
</plugins> </plugins>
</build> </build>
<reporting> <reporting>
<plugins> <plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
<version>2.11</version>
<configuration>
<issueLinkTemplatePerSystem>
<Gitlab>%URL%/%ISSUE%</Gitlab>
</issueLinkTemplatePerSystem>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>changes-report</report>
</reports>
</reportSet>
</reportSets>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId> <artifactId>maven-checkstyle-plugin</artifactId>
...@@ -273,6 +342,19 @@ ...@@ -273,6 +342,19 @@
</reportSets> </reportSets>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.1</version>
<configuration>
<links>
<link>${basedir}/src/site/index.html</link>
</links>
<!-- <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile> -->
<!-- <show>public</show> -->
</configuration>
</plugin>
<plugin> <plugin>
<groupId>org.codehaus.mojo</groupId> <groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId> <artifactId>findbugs-maven-plugin</artifactId>
...@@ -345,4 +427,5 @@ ...@@ -345,4 +427,5 @@
</profile> </profile>
</profiles> </profiles>
</project> </project>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<launchConfiguration type="org.eclipse.m2e.Maven2LaunchConfigurationType">
<booleanAttribute key="M2_DEBUG_OUTPUT" value="false"/>
<stringAttribute key="M2_GOALS" value="site"/>
<booleanAttribute key="M2_NON_RECURSIVE" value="false"/>
<booleanAttribute key="M2_OFFLINE" value="false"/>
<stringAttribute key="M2_PROFILES" value=""/>
<listAttribute key="M2_PROPERTIES"/>
<stringAttribute key="M2_RUNTIME" value="EMBEDDED"/>
<booleanAttribute key="M2_SKIP_TESTS" value="false"/>
<intAttribute key="M2_THREADS" value="1"/>
<booleanAttribute key="M2_UPDATE_SNAPSHOTS" value="false"/>
<stringAttribute key="M2_USER_SETTINGS" value=""/>
<booleanAttribute key="M2_WORKSPACE_RESOLUTION" value="false"/>
<booleanAttribute key="org.eclipse.jdt.launching.ATTR_USE_START_ON_FIRST_THREAD" value="true"/>
<stringAttribute key="org.eclipse.jdt.launching.WORKING_DIRECTORY" value="/Users/nel/git/teetime"/>
</launchConfiguration>
<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="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
<?xml version="1.0" encoding="UTF-8"?>
<faqs xmlns="http://maven.apache.org/FML/1.0.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
title="Frequently Asked Questions"
toplink="false">
<part id="general">
<title>General</title>
<faq id="whats-foo">
<question>
What is Foo?
</question>
<answer>
<p>some markup goes here</p>
<source>some source code</source>
<p>some markup goes here</p>
</answer>
</faq>
<faq id="whats-bar">
<question>
What is Bar?
</question>
<answer>
<p>some markup goes here</p>
</answer>
</faq>
</part>
<part id="install">
<title>Installation</title>
<faq id="how-install">
<question>
How do I install Foo?
</question>
<answer>
<p>some markup goes here</p>
</answer>
</faq>
</part>
</faqs>
\ No newline at end of file
## Contribute
If you want to participate in the development, feel free to [contact us](team-list.html).
### Access to source code
You can also download the source code from our Git repository.
Following URL's will give you read-only access to our server:
```xml
ssh://gitlab@build.se.informatik.uni-kiel.de:chw/teetime.git
```
or
```xml
http://build.se.informatik.uni-kiel.de/gitlab/chw/teetime.git
```
### Workflow
If you contribute, please follow our guidelines to comply to our quality standards.
#### Git guidelines
- To update a branch, use the code commands ``fetch`` and ``rebase`` in this order.
- Create a new branch for every code modification you want to perform.
- Contribute your changes and fixes by using the [merge request](https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/merge_requests) function in GitLab.
- Last, but not least, participate in discussions within our issue tracking system.
#### Issue tracking
- Create a ticket for every major bug.
- Comment on tickets you are working on and let others know what you are doing.
- Describe the issue in a short but understandable way.
- Use Tags for tickets, which fit the issue and mark bugs as ``solved``.
### Support
If you are using TeeTime and run into problems, consider to report the issue or [contact us](team-list.html). Every reported issue can help to improve TeeTime.
We really appreciate any ideas or suggestions.
\ No newline at end of file
# Download
There are several ways to get TeeTime. Choose the best one for you.
## Latest stable
There are two simple ways to add TeeTime to your own project.
>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</version>
</dependency>
```
<!--- Dependency informations for other project management tools can be found [here](dependency-info.html). -->
Please make sure, your project management 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>
<groupId>net.sourceforge.teetime</groupId>
<artifactId>teetime</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
```
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:
```xml
<repositories>
<repository>
<id>sonatype.oss.snapshots</id>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</repository>
</repositories>
```
#### 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/).
## Release notes
All changes can be found on our [release notes](changes-report.html) page.
#### TeeTime
![Screenshot](images/code_screenshot.jpg)
Implement your analysis or filters in a new, easy and fast way.
#### Simple & Fast
![Pipelining](images/code_screenshot.png)
The main focus is on fast execution and easy usage.
#### Start today
![Pipelining](images/code_screenshot.jpg)
Predefined stages are provided within the source code. You can immediatly start to write your own analysis.
---
## What is it?
<!--- ![Logo](images/teetime-wo-arrows-shrinked.png) TeeTime Logo -->
TeeTime is a Pipes-And-Filters-Framework for Java.
It provides various features, which will bring you to the next level of analysis programming, such like:
- Concurrent execution of stages
- Flexible connection between stages
- Typed ports
- Pre-defined stages and pipelines
## Where to get it
TeeTime is available in many ways. If your projects use Maven, just add following dependency to your ``pom.xml``:
```xml
<dependency>
<groupId>net.sourceforge.teetime</groupId>
<artifactId>teetime</artifactId>
<version>1.0</version>
</dependency>
```
>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:
- [TeeTime's Wiki](https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/wikis/home).
- [API Documentation](apidocs/index.html).
\ No newline at end of file
wiki @ 0e447457
Subproject commit 0e4474577e1f49bc96e734c286b2d9e0363895e8
body {
background-image:url(../images/bg.png);
}
.slogan {
color: #7E7E7E;
}
\ No newline at end of file
src/site/resources/images/bg.png

167 KiB

src/site/resources/images/code_screenshot.jpg

460 KiB

src/site/resources/images/code_screenshot.png

342 KiB

https://www.iconfinder.com/icons/56268/clock_time_wait_watch_icon
\ No newline at end of file
src/site/resources/images/teetime-w-arrows.png

45.6 KiB

src/site/resources/images/teetime-wo-arrows-shrinked.png

44.4 KiB

src/site/resources/images/teetime-wo-arrows-text-small.png

13 KiB

src/site/resources/images/teetime-wo-arrows-text.png

43.5 KiB

src/site/resources/images/teetime-wo-text-25.png

4.27 KiB

src/site/resources/images/teetime-wo-text-small.png

13 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment