zutil/README.md

33 lines
874 B
Markdown
Raw Normal View History

# Zutil
2016-09-23 15:51:40 +02:00
2016-09-28 15:09:49 +02:00
This project is a collection of utility classes and methods that I use in most
of my projects. Some of the code is incomplete and might never be completed
(If no one is requesting otherwise :D).
2016-09-23 15:51:40 +02:00
2016-09-28 15:09:49 +02:00
**A word of warning:** This project is mostly used as a sandbox to implement
APIs and functions I think are interesting. So there are no guaranties that
classes and methods will stay as they are, I'm often refactoring the code and
moving things around.
2016-09-23 15:51:40 +02:00
2016-09-28 15:09:49 +02:00
## Documentation
Unfortunately, there is no dedicated documentation available. The only documentation
is the JavaDoc in the source code and the JUnit test cases as usage examples.
2016-09-23 15:51:40 +02:00
## Running the tests
Execute all JUnit test-cases by running:
```
mvn verify
2016-09-23 15:51:40 +02:00
```
## Authors
* **Ziver Koc**
## License
2016-09-28 15:09:49 +02:00
This project is licensed under the MIT License -
see the [LICENSE.txt](LICENSE.txt) file for details
2016-09-23 15:51:40 +02:00