diff --git a/README.md b/README.md index 97b5336c7..ccd130892 100644 --- 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) \ No newline at end of file +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 deleted file mode 100644 index 0db646347..000000000 --- a/opennlp-distr/README +++ /dev/null @@ -1,40 +0,0 @@ -Apache OpenNLP ${pom.version} -=============================== - -Requirements ------------- -Java 1.8 is required to run OpenNLP -Maven 3.3.9 is required for building it - -Building from the Source Distribution -------------------------------------- - -To build everything execute the following command in the root folder: - mvn clean install - -The results of the build will be placed in: - opennlp-distr/target/apache-opennlp-[version]-bin.tar-gz (or .zip) - -What is new in Apache OpenNLP ${pom.version} ---------------------------------------- - -This release introduces many new features, improvements and bug fixes. The API -has been improved for a better consistency and many deprecated methods were -removed. Java 1.8 is required. - -Additionally the release contains the following noteworthy changes: - -- A new Language Detection Component -- Support for Irish Sentence Bank formats -- Support to train the sentence detector and tokenizer on the UD corpus -- Evaluation tests now support ISO-639-3 language codes -- Convenience methods to load models from a path -- Refactored the Data Indexer Code -- Optimized NGram creation loop to better leverage CPU cache -- Refactored BratNameSampleStream -- Remove deprecated code from util package -- Redesigned web site - https://opennlp.apache.org -- New logo for the project - -A detailed list of the issues related to this release can be found in the release -notes. diff --git a/opennlp-distr/README_HEADER.html b/opennlp-distr/README_HEADER.html new file mode 100644 index 000000000..7d3b0e205 --- /dev/null +++ b/opennlp-distr/README_HEADER.html @@ -0,0 +1,28 @@ + + + + + + Apache OpenNLP Readme + + diff --git a/opennlp-distr/pom.xml b/opennlp-distr/pom.xml index e8a603df3..e9a848e81 100644 --- a/opennlp-distr/pom.xml +++ b/opennlp-distr/pom.xml @@ -32,6 +32,10 @@ pom Apache OpenNLP Distribution + + ${pom.version} + + @@ -54,6 +58,24 @@ + + com.ruleoftech + markdown-page-generator-plugin + 1.0.0 + + + process-sources + + generate + + + + + ${basedir}/../ + ${basedir}/target + ${basedir}/README_HEADER.html + + maven-assembly-plugin diff --git a/opennlp-distr/src/main/assembly/bin.xml b/opennlp-distr/src/main/assembly/bin.xml index b1e27c884..e81b6d555 100644 --- a/opennlp-distr/src/main/assembly/bin.xml +++ b/opennlp-distr/src/main/assembly/bin.xml @@ -46,7 +46,7 @@ src/main/readme 644 755 - . + . @@ -55,11 +55,20 @@ 644 755 - README RELEASE_NOTES.html - + + + target + 644 + 755 + . + + README.html + + + target/issuesFixed 644