Updated ASF copyright
[incubator-taverna-workbench-product.git] / README.md
1 <!--
2    Licensed to the Apache Software Foundation (ASF) under one or more
3    contributor license agreements.  See the NOTICE file distributed with
4    this work for additional information regarding copyright ownership.
5    The ASF licenses this file to You under the Apache License, Version 2.0
6    (the "License"); you may not use this file except in compliance with
7    the License.  You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 -->
17
18 # Apache Taverna Workbench Product
19
20 Packaging of the
21 [Apache Taverna](http://taverna.incubator.apache.org/)
22 workbench installation.
23 This repository depends on the rest of the
24 [Apache Taverna modules](http://taverna.incubator.apache.org/code/).
25
26
27
28 ## License
29
30 (c) 2010-2014 University of Manchester
31
32 (c) 2014-2015 Apache Software Foundation
33
34 This product includes software developed at The
35 [Apache Software Foundation](http://www.apache.org/).
36
37 Licensed under the
38 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file
39 [LICENSE](LICENSE) for details.
40
41 The file [NOTICE](NOTICE) contain any additional attributions and
42 details about embedded third-party libraries and source code.
43
44
45 # Contribute
46
47 Please subscribe to and contact the
48 [dev@taverna](http://taverna.incubator.apache.org/community/lists#dev mailing list)
49 for any questions, suggestions and discussions about
50 Apache Taverna.
51
52 Bugs and feature plannings are tracked in the Jira
53 [Issue tracker](https://issues.apache.org/jira/browse/TAVERNA/component/12326816)
54 under the `TAVERNA` component _Taverna Workbench Product._ Feel free
55 to add an issue!
56
57 To suggest changes to this source code, feel free to raise a
58 [GitHub pull request](https://github.com/apache/incubator-taverna-workbench-product/pulls).
59 Any contributions received are assumed to be covered by the [Apache License
60 2.0](https://www.apache.org/licenses/LICENSE-2.0). We might ask you
61 to sign a [Contributor License Agreement](https://www.apache.org/licenses/#clas)
62 before accepting a larger contribution.
63
64 ## Disclaimer
65
66 Apache Taverna is an effort undergoing incubation at the
67 [Apache Software Foundation (ASF)](http://www.apache.org/),
68 sponsored by the [Apache Incubator PMC](http://incubator.apache.org/).
69
70 [Incubation](http://incubator.apache.org/incubation/Process_Description.html)
71 is required of all newly accepted projects until a further review
72 indicates that the infrastructure, communications, and decision making process
73 have stabilized in a manner consistent with other successful ASF projects.
74
75 While incubation status is not necessarily a reflection of the completeness
76 or stability of the code, it does indicate that the project has yet to be
77 fully endorsed by the ASF.
78
79
80
81 ## Prerequisites
82
83 * Java 1.7 or newer (tested with OpenJDK 1.8)
84 * [Apache Maven](https://maven.apache.org/download.html) 3.2.5 or newer (older
85   versions probably also work)
86
87
88 # Building
89
90 To build, use
91
92     mvn clean install
93
94 This will build each module and run their tests.
95
96
97 ## Skipping tests
98
99 To skip the tests (these can be timeconsuming), use:
100
101     mvn clean install -DskipTests
102
103
104 If you are modifying this source code independent of the
105 Apache Taverna project, you may not want to run the
106 [Rat Maven plugin](https://creadur.apache.org/rat/apache-rat-plugin/)
107 that enforces Apache headers in every source file - to disable it, try:
108
109     mvn clean install -Drat.skip=true