[OPENNLP-1127] Fix readme HTML file generated for distribution archives

• Type: Bug
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 1.8.1
• Fix Version/s: 1.8.2
• Component/s: Build, Packaging and Test
• Labels: build documentation
• Flags: Patch
• Assignee: Bruno P. Kinoshita
• Reporter: Bruno P. Kinoshita
• Created: 06/Sep/17 10:55
• Updated: 10/Oct/17 09:56
• Resolved: 10/Oct/17 09:56

Description

The current README.md file, in the project root directory, is used by the opennlp-distr module. The readme file is included in distribution files. There are a few changes in the master branch that were not released yet.

Running `mvn clean install` will create the distribution files, and inside you should find a README.html created based on the README.md file, plus other files.

The Markdown to HTML generation is being done through https://github.com/walokra/markdown-page-generator-plugin.

This issue is for enhancements in the README file and also around the markdown-page-generator-plugin use. As 1.8.2 release is in progress, this may be included in 1.8.3.

Cheers
Bruno

Issue Links

• links to: GitHub Pull Request #261