Skip to content

Commit 3f3b4c9

Browse files
kottmannkottmann
committed
OPENNLP-1126: Consoldiate readme files into README.md
1 parent d3f0ee5 commit 3f3b4c9

File tree

5 files changed

+64
-45
lines changed

5 files changed

+64
-45
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ libraryDependencies += "org.apache.opennlp" % "opennlp-tools" % "${opennlp.versi
9292

9393
#### Gradle
9494
```
95-
compile group: "org.apache.opennlp", name: "opennlp-tools", version: "$opennlp.version"
95+
compile group: "org.apache.opennlp", name: "opennlp-tools", version: "${opennlp.version}"
9696
```
9797

9898

@@ -112,4 +112,4 @@ mvn install
112112

113113
The Apache OpenNLP project is developed by volunteers and is always looking for new contributors to work on all parts of the project. Every contribution is welcome and needed to make it better. A contribution can be anything from a small documentation typo fix to a new component.
114114

115-
If you would like to get involved please follow the instructions [here](https://github.com/apache/opennlp/blob/master/.github/CONTRIBUTING.md)
115+
If you would like to get involved please follow the instructions [here](https://github.com/apache/opennlp/blob/master/.github/CONTRIBUTING.md)

‎opennlp-distr/README‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎opennlp-distr/README_HEADER.html‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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+
<!DOCTYPE html>
19+
<html lang="en">
20+
<head>
21+
<title>Apache OpenNLP Readme</title>
22+
<style>
23+
[href='https://travis-ci.org/apache/opennlp']{ display: none }
24+
[href='https://coveralls.io/github/apache/opennlp?branch=master']{ display: none }
25+
[href='https://maven-badges.herokuapp.com/maven-central/org.apache.opennlp/opennlp']{ display: none }
26+
[href='http://opennlp.apache.org/docs/index.html']{ display: none }
27+
</style>
28+
</head>

‎opennlp-distr/pom.xml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
<packaging>pom</packaging>
3333
<name>Apache OpenNLP Distribution</name>
3434

35+
<properties>
36+
<opennlp.version>${pom.version}</opennlp.version>
37+
</properties>
38+
3539
<!-- Versions will automatically be updated by the release plugin -->
3640
<dependencies>
3741
<dependency>
@@ -54,6 +58,24 @@
5458

5559
<build>
5660
<plugins>
61+
<plugin>
62+
<groupId>com.ruleoftech</groupId>
63+
<artifactId>markdown-page-generator-plugin</artifactId>
64+
<version>1.0.0</version>
65+
<executions>
66+
<execution>
67+
<phase>process-sources</phase>
68+
<goals>
69+
<goal>generate</goal>
70+
</goals>
71+
</execution>
72+
</executions>
73+
<configuration>
74+
<inputDirectory>${basedir}/../</inputDirectory>
75+
<outputDirectory>${basedir}/target</outputDirectory>
76+
<headerHtmlFile>${basedir}/README_HEADER.html</headerHtmlFile>
77+
</configuration>
78+
</plugin>
5779
<plugin>
5880
<artifactId>maven-assembly-plugin</artifactId>
5981
<executions>

‎opennlp-distr/src/main/assembly/bin.xml‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
<directory>src/main/readme</directory>
4747
<fileMode>644</fileMode>
4848
<directoryMode>755</directoryMode>
49-
<outputDirectory>.</outputDirectory>
49+
<outputDirectory>.</outputDirectory>
5050
</fileSet>
5151

5252
<fileSet>
@@ -55,11 +55,20 @@
5555
<fileMode>644</fileMode>
5656
<directoryMode>755</directoryMode>
5757
<includes>
58-
<include>README</include>
5958
<include>RELEASE_NOTES.html</include>
6059
</includes>
6160
</fileSet>
62-
61+
62+
<fileSet>
63+
<directory>target</directory>
64+
<fileMode>644</fileMode>
65+
<directoryMode>755</directoryMode>
66+
<outputDirectory>.</outputDirectory>
67+
<includes>
68+
<include>README.html</include>
69+
</includes>
70+
</fileSet>
71+
6372
<fileSet>
6473
<directory>target/issuesFixed</directory>
6574
<fileMode>644</fileMode>

0 commit comments

Comments
 (0)