aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEduardo Pedroni <e.pedroni91@gmail.com>2015-06-18 18:37:37 +0200
committerEduardo Pedroni <e.pedroni91@gmail.com>2015-06-18 18:37:37 +0200
commit46c25bd120e853834e61cb321a4f75e3e71aa21d (patch)
tree099ddb52207258df758e246f3af837df377c29e7 /README.md
parent231906701e8cf5b00058e23e6a666a2f9a3e566e (diff)
Added license, updated readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index f79e476..629718f 100644
--- a/README.md
+++ b/README.md
@@ -59,3 +59,9 @@ Peruse optionally accepts a card number as an argument. If present, only that ca
### Committing Changes and Exiting
Any changes made on this tool must be manually written to the file. If you make a mistake, simply exit and your cardbase will not be modified. To write changes, use the "write" command. To save to a new file, type "write" followed by the file name (no spaces allowed). To exit, simply type "exit".
+
+## Building
+
+The Ant build script can be found under /build. The default target "deploy" compiles and packs all necessary binaries into a single executable jar, /dist/cardbase.jar.
+
+Linux users can execute "shebang" to create a concatenation of the shebang defined in /build/header (by default #!/usr/bin/java -jar) and the deployed jar, saved as the executable /dist/cardbase.