ziver/zutil
1
0
Fork 0
Code Issues Pull requests Activity Actions

Updated README file

Browse source
This commit is contained in:
Ziver Koc 2016-09-28 15:09:49 +02:00
parent 24c4fac26d
commit 34c9f5da91
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,10 +1,17 @@
# Hal # Hal
This project is a collection of utility classes and methods that I use in most of my projects. This project is a collection of utility classes and methods that I use in most
Some of the code is incomplete and might never be completed (If no one is requesting otherwise :D). of my projects. Some of the code is incomplete and might never be completed
(If no one is requesting otherwise :D).
**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. **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.
## Documentation
Unfortunately, there is no dedicated documentation available. The only documentation
is the JavaDoc in the source code and see the JUnit test cases for usage examples.
## Running the tests ## Running the tests
@ -20,5 +27,6 @@ ant test
## License ## License
This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details This project is licensed under the MIT License -
see the [LICENSE.txt](LICENSE.txt) file for details