diff --git a/README.md b/README.md old mode 100644 new mode 100755 index e69de29..5a86071 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +# Hal + +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). + +**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. + + +## Running the tests + +Execute all JUnit test-cases by running: +``` +ant test +``` + +## Authors + +* **Ziver Koc** + + +## License + +This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details +