diff --git a/README.md b/README.md index 6968116..7f82817 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,20 @@ CoffeeBreak =========== -A commandline application you can use to go take a quick coffee break while your boss thinks you're compiling. +As the title of this program suggests, its purpose is for you to take a quick coffee break. + +Some of us have bosses that don't know anything about programming, and if they do they can't differenciate between a real compilation and a fake one like this; this is for them. + +Simply set this running at full screen and when someone asks just tell them you're compiling ;). + +### Compiling +To compile make sure you have the java compiler installed along with Apache Ant. Then run simply the following command: +```bash +$ ant +``` + +### Contributing +Simply send me a pull request. I always need new fake compilers, so feel free to add whatever will fool your boss! + +### License +This project is licensed with the [GNU GPLv3](/LICENSE).