Skip to content

Commit ecca16a

Browse files
committed
Udpated documentation, added attributes for urls
1 parent 1a43d25 commit ecca16a

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

README.adoc

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
:toc:
33
:toc-placement: preamble
44
:currentversion: 0.4.2
5-
:wikiUrl: https://github.com/ToToTec/CmdOption/wiki
5+
:githubUrl: https://github.com/ToToTec/CmdOption
6+
:wikiUrl: {githubUrl}/wiki
7+
:gitterUrl: https://gitter.im/ToToTec/CmdOption
68

79
image:https://travis-ci.org/ToToTec/CmdOption.svg?branch=master["Build Status", link="https://travis-ci.org/ToToTec/CmdOption"]
810
image:https://www.codacy.com/project/badge/e3f730346034401281fa8e3fe4802afd["Codacy Badge", link="https://www.codacy.com/p/3189/dashboard"]
@@ -553,12 +555,13 @@ When used, CmdOption will display detailed information about the found configura
553555
This might help to understand issues further.
554556
In most cases, this will help you to resolve your issues. Of course, you can disable this functionality with `CmdlineParser.setDebugModeAllowed(false)`.
555557

556-
If you have issues you can not solve, do not hessitate to https://github.com/ToToTec/CmdOption/issues/new[open a support ticket] or search for other (open) issues in the https://github.com/ToToTec/CmdOption/issues[CmdOption ticket system].
558+
If you have issues you can not solve, do not hessitate to https://github.com/ToToTec/CmdOption/issues/new[open a support ticket] or search for other (open) issues in the {githubUrl}/issues[CmdOption ticket system].
559+
You can also start a chat in our {gitterUrl}[Gitter room].
557560

558561
== Creating a streaming command line interface
559562

560563
Normally, CmdOption parses a complete command line, populates the config object(s) and ensures, that the config is valid, according to the configuration.
561-
Only, if the config is checked and ok, the parse method returns.
564+
Only, if the config is checked and ok, the parse method returns normally.
562565

563566
In some cases, a streaming command line interface is more appropriate than the typical static approach.
564567
In a streaming command line interface each option and parameter is immediatly evaluated before the next option or parameter is read.
@@ -580,12 +583,12 @@ CmdOption is developed and released under the *Apache License, Version 2*.
580583

581584
Your contributions are much apreciated and are assumed to be published under the terms of the link:#license[project license] if not stated otherwise.
582585

583-
If you found a bug or have a feature request, please open a https://github.com/ToToTec/CmdOption/issues[new issue on GitHub].
586+
If you found a bug or have a feature request, please open a {githubUrl}/issues[new issue on GitHub].
584587
We also accept pull requests.
585588

586-
You can also use our https://gitter.im/ToToTec/CmdOption[Chat on Gitter.im] for discussions and questions.
589+
You can also use our {gitterUrl}[Chat on Gitter.im] for discussions and questions.
587590

588-
If you want to show appreciation for the project, please "star" it on https://github.com/ToToTec/CmdOption[GitHub].
591+
If you want to show appreciation for the project, please "star" it on {githubUrl}[GitHub].
589592
That helps me setting my priorities.
590593

591594
== Building CmdOption from Source
@@ -608,7 +611,7 @@ The built JAR file can be found under `de.tototec.cmdoption/target/de.tototec.cm
608611

609612
You want to create a new or update an existing translation?
610613

611-
CmdOption uses GNU Gettext. The translations are located under `src/main/po`. The message catalog template will be extracted in the compile phase and is located under `target/po/messages.pot`.
614+
CmdOption uses GNU Gettext. The translations are located under `src/main/po`. The message catalog template will be extracted in the compile phase (`mvn clean compile`) and is located under `target/po/messages.pot`.
612615

613616
To update the translation files under `src/main/po` use the `update-message` profile.
614617

@@ -617,6 +620,11 @@ To update the translation files under `src/main/po` use the `update-message` pro
617620
mvn -Pupdate-messages clean compile
618621
----
619622

623+
After that, edit the translation files and update the fuzzy or newly added messages. ``*.po` files are normal text files, but using a po-Editor like e.g. poedit might be more convenient.
624+
625+
If you update the translation please open a {githubUrl}/pulls[pull-request] with the new translation.
626+
627+
620628
=== Create `pom.xml` for interoperability, e.g. IDEs
621629

622630
To generate the `pom.xml` use hte `gen-pom-xml` profile.

0 commit comments

Comments
 (0)