aboutsummaryrefslogtreecommitdiffstats
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
parent231906701e8cf5b00058e23e6a666a2f9a3e566e (diff)
Added license, updated readme
-rw-r--r--LICENSE13
-rw-r--r--README.md6
2 files changed, 19 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f4c7925
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2015 Eduardo Pedroni
+
+This program is free software: you can redistribute it and/or modify it under the terms of the
+GNU General Public License version 3 as published by the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU General Public License for more details <http://www.gnu.org/licenses/>.
+
+
+
+The Jackson library included is licensed under the Apache License and has not been modified.
+The AL can be found at http://www.apache.org/licenses/LICENSE-2.0.
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.