You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@taverna.apache.org by st...@apache.org on 2015/07/13 15:40:29 UTC

[2/2] incubator-taverna-osgi git commit: README License/contribute section

README License/contribute section


Project: http://git-wip-us.apache.org/repos/asf/incubator-taverna-osgi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-taverna-osgi/commit/68a43191
Tree: http://git-wip-us.apache.org/repos/asf/incubator-taverna-osgi/tree/68a43191
Diff: http://git-wip-us.apache.org/repos/asf/incubator-taverna-osgi/diff/68a43191

Branch: refs/heads/master
Commit: 68a4319162f415b1660b21224c17caf3094a918a
Parents: 593026a
Author: Stian Soiland-Reyes <so...@cs.manchester.ac.uk>
Authored: Mon Jul 13 14:37:51 2015 +0100
Committer: Stian Soiland-Reyes <so...@cs.manchester.ac.uk>
Committed: Mon Jul 13 14:37:51 2015 +0100

----------------------------------------------------------------------
 README.md | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 91 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-taverna-osgi/blob/68a43191/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index dd2958f..e44fb03 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,96 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+
 # Apache Taverna OSGi plugin system
 
-[![Build Status](https://travis-ci.org/taverna-incubator/incubator-taverna-osgi.svg)](https://travis-ci.org/taverna-incubator/incubator-taverna-osgi)
+OSGi-based plugin system, including online updates. Written for
+[Apache Taverna](http://taverna.incubator.apache.org/) (incubating),
+probably usable for any OSGi-based command line/desktop product.
+
+
+## License
+
+(c) 2007-2014 University of Manchester
+(c) 2015 Apache Software Foundation
+
+This product includes software developed at The [Apache Software
+Foundation](http://www.apache.org/).
+
+Licensed under the
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file
+[LICENSE](LICENSE) for details.
+
+The file [NOTICE](NOTICE) contain any additional attributions and
+details about embedded third-party libraries and source code.
+
+
+## Contribute
+
+Feel free to
+[contribute to Apache Taverna](http://taverna.incubator.apache.org/download/code/#contribute-to-apache-taverna)
+by [submitting an issue](https://issues.apache.org/jira/browse/TAVERNA), send a
+[pull request](https://github.com/apache/incubator-taverna-osgi/pulls), or discuss the project at
+the [dev@taverna mailing list](http://taverna.incubator.apache.org/community/lists#devtaverna).
+
+All contributions are assumed to be licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), unless otherwise noted.
+
+## Disclaimer
+
+Apache Taverna is an effort undergoing incubation at the
+[Apache Software Foundation (ASF)](http://www.apache.org/),
+sponsored by the [Apache Incubator PMC](http://incubator.apache.org/).
+
+[Incubation](http://incubator.apache.org/incubation/Process_Description.html)
+is required of all newly accepted projects until a further review
+indicates that the infrastructure, communications, and decision making process
+have stabilized in a manner consistent with other successful ASF projects.
+
+While incubation status is not necessarily a reflection of the completeness
+or stability of the code, it does indicate that the project has yet to be
+fully endorsed by the ASF.
+
+
+
+## Prerequisites
+
+* Java 1.7 or newer (tested with OpenJDK 1.8)
+* [Apache Maven](https://maven.apache.org/download.html) 3.2.5 or newer (older
+  versions probably also work)
+
+
+# Building
+
+To build, use
+
+    mvn clean install
+
+This will build each module and run their tests.
+
+
+## Skipping tests
+
+To skip the tests (these can be timeconsuming), use:
+
+    mvn clean install -DskipTests
 
-OSGi-based plugin system, including online updates. Written for Apache Taverna, probably 
-usable for any OSGi-based command line/desktop product.
 
+If you are modifying this source code independent of the
+Apache Taverna project, you may not want to run the
+[Rat Maven plugin](https://creadur.apache.org/rat/apache-rat-plugin/)
+that enforces Apache headers in every source file - to disable it, try:
 
+    mvn clean install -Drat.skip=true