Skip to content

Commit

Permalink
added first readme-stub
Browse files Browse the repository at this point in the history
  • Loading branch information
Kopfi committed Dec 2, 2014
1 parent da3eb7f commit f823d0b
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#jqcdm Java Library

##Description
jqcdm is a very small library (well more a random bundle of classes) to get started with the QCDM protocol in Java. It
was initially written by using data, code and concepts from ModemManager libqcdm library.


##Credits
All credits should go to the [ModemManager project] (http://www.freedesktop.org/wiki/Software/ModemManager/). This
project alone made it possible to write this small Java port.


##Dependencies
Currently the library depends on following external libraries to build correctly:
* [jssc](https://code.google.com/p/java-simple-serial-connector/), Version 2.8.0, GNU LGPL
* [Apache log4j](http://logging.apache.org/log4j/), Version 2.1, Apache License 2.0

The log4j Framework is used, because of personal feelings. But the framework isn't that big. If anyone doesn't like
the log4j Framework it should be doable to remove every reference in a reasonable amount of time.
The above list may not be correct at all times. Have a look at the `ivy.xml` file to be sure.

The build system depends on the following elements:
* a Java JDK (of course)
* Apache Ant
* Apache Ivy (will be downloaded by the ant file, if `ivy.jar` is not present)

0 comments on commit f823d0b

Please sign in to comment.