OPENNLP-1126: Consoldiate readme files into README.md

apache · Sep 4, 2017 · 3f3b4c9 · 3f3b4c9
1 parent d3f0ee5
commit 3f3b4c9
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -92,7 +92,7 @@ libraryDependencies += "org.apache.opennlp" % "opennlp-tools" % "${opennlp.versi
 
 #### Gradle
 ```
-compile group: "org.apache.opennlp", name: "opennlp-tools", version: "$opennlp.version"
+compile group: "org.apache.opennlp", name: "opennlp-tools", version: "${opennlp.version}"
 ```
 
 
@@ -112,4 +112,4 @@ mvn install
 
 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.
 
-If you would like to get involved please follow the instructions [here](https://github.com/apache/opennlp/blob/master/.github/CONTRIBUTING.md)
+If you would like to get involved please follow the instructions [here](https://github.com/apache/opennlp/blob/master/.github/CONTRIBUTING.md)
diff --git a/opennlp-distr/README b/opennlp-distr/README
diff --git a/opennlp-distr/README_HEADER.html b/opennlp-distr/README_HEADER.html
@@ -0,0 +1,28 @@
+<!--
+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.
+-->
+
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Apache OpenNLP Readme</title>
+    <style>
+        [href='https://travis-ci.org/apache/opennlp']{ display: none }
+        [href='https://coveralls.io/github/apache/opennlp?branch=master']{ display: none }
+        [href='https://maven-badges.herokuapp.com/maven-central/org.apache.opennlp/opennlp']{ display: none }
+        [href='http://opennlp.apache.org/docs/index.html']{ display: none }
+    </style>
+</head>
diff --git a/opennlp-distr/pom.xml b/opennlp-distr/pom.xml
@@ -32,6 +32,10 @@
 	<packaging>pom</packaging>
 	<name>Apache OpenNLP Distribution</name>
 
+	<properties>
+		<opennlp.version>${pom.version}</opennlp.version>
+	</properties>
+
 	<!--  Versions will automatically be updated by the release plugin -->
 	<dependencies>
 		<dependency>
@@ -54,6 +58,24 @@
 
 	<build>
 		<plugins>
+			<plugin>
+				<groupId>com.ruleoftech</groupId>
+				<artifactId>markdown-page-generator-plugin</artifactId>
+				<version>1.0.0</version>
+				<executions>
+					<execution>
+						<phase>process-sources</phase>
+						<goals>
+							<goal>generate</goal>
+						</goals>
+					</execution>
+				</executions>
+				<configuration>
+					<inputDirectory>${basedir}/../</inputDirectory>
+					<outputDirectory>${basedir}/target</outputDirectory>
+					<headerHtmlFile>${basedir}/README_HEADER.html</headerHtmlFile>
+				</configuration>
+			</plugin>
 			<plugin>
 				<artifactId>maven-assembly-plugin</artifactId>
 				<executions>

diff --git a/opennlp-distr/src/main/assembly/bin.xml b/opennlp-distr/src/main/assembly/bin.xml
@@ -46,7 +46,7 @@
 	    	<directory>src/main/readme</directory>
 	    	<fileMode>644</fileMode>
 	    	<directoryMode>755</directoryMode>
-			<outputDirectory>.</outputDirectory>
+	    	<outputDirectory>.</outputDirectory>
 	    </fileSet>
 
 	    <fileSet>
@@ -55,11 +55,20 @@
 	      <fileMode>644</fileMode>
 	      <directoryMode>755</directoryMode> 
 	      <includes>
-	        <include>README</include>
 	        <include>RELEASE_NOTES.html</include>
 	      </includes>       
 	    </fileSet>
-
+
+	    <fileSet>
+	      <directory>target</directory>
+	      <fileMode>644</fileMode>
+	      <directoryMode>755</directoryMode>
+	      <outputDirectory>.</outputDirectory>
+	      <includes>
+	        <include>README.html</include>
+	      </includes>
+	    </fileSet>
+
 	    <fileSet>
 	      <directory>target/issuesFixed</directory>
 	      <fileMode>644</fileMode>