X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=blobdiff_plain;f=doc%2Findex.html;fp=doc%2Findex.html;h=4648538b3c5da62ec529c6b653e4ae79d791a2cb;hp=cf028f3b36c17c48e2aa45a4ffd6828ed969f73c;hb=324ea20c0c65f671c0d35e94ed90142912a56b4c;hpb=2c29a140b3ff6f0f60ac838437c4bd9b8fd6dad7 diff --git a/doc/index.html b/doc/index.html index cf028f3..4648538 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + CLI Helper - library to help implementing commandline interfaces @@ -202,19 +202,23 @@

Table of Contents

-
-

1. General

+
+

1. General

  • This program is free software: released under Creative Commons Zero @@ -231,8 +235,8 @@
-
-

1.1. Source code

+
+

1.1. Source code

-
-

2. Library contents

+
+

2. Library contents

-

  • -Commandline Interface helper +

    +This library is a collection of command-line interface (CLI) helper +functions that simplifies the process of building and maintaining CLI +applications. The library provides several different functionalities, +such as:

    -
    -eu.svjatoslav.commons.cli_helper.CLIHelper
-
    • -

  • -Commandline arguments parser and validator. -

    -
    -eu.svjatoslav.commons.cli_helper.parameter_parser
-
    • +
    + +
    +

    2.1. Ask for user input

    +
    +
    +
    askBoolean()
    Asks the user to enter a boolean value (yes/no).
    +
    askLong()
    Asks the user to enter an integer.
    +
    askString()
    Asks the user to enter a string.
    +
    +
    +
    -
    -

    3. Usage

    +
    +

    3. Getting the library

    -Instructions to embed svjatoslav-commons in your project as a library: +Instructions to embed svjatoslav-commons library in your project:

    @@ -287,26 +300,26 @@ Maven pom.xml file snippet:

    -
    <dependencies>
+
    <dependencies>
     ...
-    <dependency>
-        <groupId>eu.svjatoslav</groupId>
-        <artifactId>cli-helper</artifactId>
-        <version>1.0</version>
-    </dependency>
+    <dependency>
+        <groupId>eu.svjatoslav</groupId>
+        <artifactId>cli-helper</artifactId>
+        <version>1.0</version>
+    </dependency>
     ...
-</dependencies>
+</dependencies>
 
 
-<repositories>
+<repositories>
     ...
-    <repository>
-        <id>svjatoslav.eu</id>
-        <name>Svjatoslav repository</name>
-        <url>http://www3.svjatoslav.eu/maven/</url>
-    </repository>
+    <repository>
+        <id>svjatoslav.eu</id>
+        <name>Svjatoslav repository</name>
+        <url>http://www3.svjatoslav.eu/maven/</url>
+    </repository>
     ...
-</repositories>
+</repositories>
    @@ -314,7 +327,7 @@ Maven pom.xml file snippet:

    Author: Svjatoslav Agejenko

    -

    Created: 2022-07-13 Wed 04:24

    +

    Created: 2023-10-12 Thu 22:18

    Validate