diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..9394f1f --- /dev/null +++ b/README.txt @@ -0,0 +1,50 @@ + + +Logging +------- + +Getting started: + +1) Build the jar file + + If you have the source distribution you will need to build the jar file + using Maven 2/3. For instructions on downloading and installing Maven see + http://maven.apache.org/. + + To build execute the command 'mvn package verify'. + The jar file will be built in the target directory. + + Note: the unit tests are executed during the verify phase and require that + the respective jar files have been created successfully. + +2) Generate the documentation + + Run the 'mvn verify site' command. The documentation will be written + to the target/site directory. The documentation has some examples of + how to use this package as well as a troubleshooting guide. + +3) Create source and binary distributions + + Run the 'mvn verify site assembly:assembly' command. The source and binary + distributions are created in the 'target' directory. + +4) Use + + Simply include the jar file built in step #1 in your classpath. Import the + classes that you want to use and you are ready to go! +