diff --git a/README.md b/README.md index b968e47..2da8fc2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ # JavaProjectTemplate Provides a Java pipeline for building applications and deploying a JAR with ease. Providing a base graphical engine (fast pixel blitting) with support for input should be enough to get any project going. -The system will also use the SigScript updating system to keep files up-to-date. \ No newline at end of file +The system will also use the SigScript updating system to keep files up-to-date. + +##Usage: +**./sig** - Shows a menu with all scripts. Example output: +``` + gitpod /workspace/JavaProjectTemplate (main) $ ./sig + + Usage: ./sig {args} + + ==== Current Configuration ===================== + PROJECT_NAME JavaProjectTemplate + PROJECT_DIR src/sig + MAIN_CLASS sig.JavaProjectTemplate + OUT_DIR bin + ===================================================== + + Command List: + build + clean + commit + jar +``` +Configuration is modified at the top of the script file while the command list includes all included modules inside of `scripts`.