updated documentation
[svjatoslav_commons.git] / doc / index.org
1 #+TITLE: Svjatoslav Commons - Java library of commonly used functions
2
3 -----
4 - [[http://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
5
6 - This program is free software; you can redistribute it and/or modify
7   it under the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public
8   License]] or later as published by the Free Software Foundation.
9
10 - Program author:
11   - Svjatoslav Agejenko
12   - Homepage: http://svjatoslav.eu
13   - Email: mailto://svjatoslav@svjatoslav.eu
14
15 - [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
16
17 * General
18 Library contains:
19 - Wildcards matcher. (?, *)
20
21 - Commandline arguments parser and validator.
22
23 - File path parser.
24
25 - Graphical error dialog.
26   - Reusable graphical dialog to capture and show program exceptions
27     and associated program call stack traceback.
28
29 - Primitive URL parameters encoder / decoder.
30
31
32 * Usage
33 Instructions to embed svjatoslav-commons in your project as a library:
34
35 Maven pom.xml file snippet:
36
37 #+BEGIN_SRC xml
38 <dependencies>
39     ...
40     <dependency>
41         <groupId>eu.svjatoslav</groupId>
42         <artifactId>svjatoslavcommons</artifactId>
43         <version>1.4</version>
44     </dependency>
45     ...
46 </dependencies>
47
48
49 <repositories>
50     ...
51     <repository>
52         <id>svjatoslav.eu</id>
53         <name>Svjatoslav repository</name>
54         <url>http://www2.svjatoslav.eu/maven/</url>
55     </repository>
56     ...
57 </repositories>
58 #+END_SRC