sahasatvik / simpletools

A library of simple tools written in Java which aims at providing a common base for future projects

SimpleTools

A library of simple tools written in Java, which aim at providing a common base for projects in the future.

Overview

The SimpleTools library provides some utility classes which make common tasks, such as interpreting command line arguments (see com.github.sahasatvik.cli), much simpler.

Documentation

The docs/ folder in this repository, as well as in SimpleToolsComplete.jar contains an extensive documentation of all of the features of every class in the library. You can start at docs/index.html.

How to Use this library in your Project

There are two ways of using this library :

1. Using the uncompressed .class files : simply copy the contents of bin/ from the repository or SimpleToolsComplete.jar into the your project directory, and import the required classes (eg. to import all of the classes in the com/github/sahasatvik/cli folder, use import com.github.sahasatvik.cli.*;. Compile as normal.

2. Using the SimpleTools.jar file : download SimpleTools.jar and copy it to a location within your project, and import the required classes as mentioned earlier. While compiling, remember to add SimpleTools.jar to your classpath, as follows :
       On UNIX based systems : javac -cp '.:path/to/jar/SimpleTools.jar' sourcefile.java
       On Windows systems : javac -cp '.;path/to/jar/SimpleTools.jar' sourcefile.java
   While executing your program, remember to add SimpleTools.jar to the classpath again, as follows :
       On UNIX based systems : java -cp '.:path/to/jar/SimpleTools.jar' sourcefile
       On Windows systems : java -cp '.;path/to/jar/SimpleTools.jar' sourcefile