summaryrefslogtreecommitdiff
path: root/README
blob: bf886aef1017ee18a322df98bf8de074ac559317 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
IceBox
======

IceBox is an inventory management application designed for use in family-owned
restaurants. Advantages over handwritten or spreadsheet inventory management
include reorder notification and waste ratio reporting.

Build
-----

The NetBeans IDE is used in developing this application, which generates `ant`
build scripts by default. You can either load the project in NetBeans yourself,
or you can build with `ant` like so:

    $ ant clean jar

The environment variable `JAVA_HOME` needs to point to a valid JDK for the
command-line build to work.

Hacking
-------

The IceBox source code uses the official code style for Java with a soft limit
on 80 columns per line in the source code. Given the verbosity of Java, some
leniency is given for particularly long lines, but try to make your code the
most readable over the must succinct.

To submit a patch, [submit your diff to Delwink][1], or use GitHub's pull
request system.

License
-------

IceBox is free (libre) software, released under the terms of version 3 of the
GNU Affero General Public License. You are free to copy, modify, and
redistribute this software and use it for any purpose. See [COPYING](COPYING)
for details.

[1]: mailto:contribute@delwink.com