doc/index.org

   1 #+TITLE: CLI Helper - library to help implementing commandline interfaces
   2
   3 * General
   4 - This program is free software: released under Creative Commons Zero
   5   (CC0) license
   6
   7 - Program author:
   8   - Svjatoslav Agejenko
   9   - Homepage: https://svjatoslav.eu
  10   - Email: mailto://svjatoslav@svjatoslav.eu
  11
  12 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
  13
  14 ** Source code
  15 - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
  16
  17 - [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]]
  18
  19 - Clone Git repository using command:
  20   : git clone https://www2.svjatoslav.eu/git/cli-helper.git
  21
  22 - See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]
  23
  24 * Library contents
  25 - See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
  26
  27 - Commandline Interface helper
  28   : eu.svjatoslav.commons.cli_helper.CLIHelper
  29
  30 - Commandline arguments parser and validator.
  31   : eu.svjatoslav.commons.cli_helper.parameter_parser
  32
  33 * Usage
  34 Instructions to embed svjatoslav-commons in your project as a library:
  35
  36 Maven pom.xml file snippet:
  37
  38 #+BEGIN_SRC xml
  39 <dependencies>
  40     ...
  41     <dependency>
  42         <groupId>eu.svjatoslav</groupId>
  43         <artifactId>cli-helper</artifactId>
  44         <version>1.0</version>
  45     </dependency>
  46     ...
  47 </dependencies>
  48
  49
  50 <repositories>
  51     ...
  52     <repository>
  53         <id>svjatoslav.eu</id>
  54         <name>Svjatoslav repository</name>
  55         <url>http://www2.svjatoslav.eu/maven/</url>
  56     </repository>
  57     ...
  58 </repositories>
  59 #+END_SRC