forked from ccavanaugh/jgnash
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.html
73 lines (73 loc) · 3.9 KB
/
readme.html
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="generator" content="ReText 4.0.1">
<title>README</title>
</head>
<body>
<p><img alt="jGnash Logo" src="http://jgnash.github.io/img/jgnash-logo.png"></p>
<h1>jGnash README</h1>
<p><a href="https://sourceforge.net/projects/jgnash/">jGnash</a> is a free (no strings attached!) personal finance manager with many of the same features as commercially-available software. It was created in order to make tracking your personal finances easy, but also provides the functionality required by advanced users. jGnash is cross-platform: jGnash 2 will run on any operating system that has a working Java 7 Runtime Environment (e.g., Linux, Mac OS X, and Microsoft Windows)</p>
<p>jGnash 2.x requires that the Java Platform version 8 or newer be installed.
jGnash has been tested with the Oracle JVM as well as the open source OpenJDK Platform.</p>
<h2>Getting Java</h2>
<p>Most users of jGnash will want the latest version of <a href="http://www.java.com/en/download/">Oracle Java Runtime Environment</a>.</p>
<p>Developers will want the Java Development Kit (see build instructions below.)</p>
<h2>Learn about jGnash</h2>
<p>To learn about the features of jGnash, visit the <a href="https://sourceforge.net/projects/jgnash/">jGnash Website</a>.</p>
<h2>Download jGnash</h2>
<p>You can download jGnash from the <a href="https://sourceforge.net/projects/jgnash/files/Active%20Stable%202.x/">jGnash Download Page</a>.</p>
<h2>To Install jGnash:</h2>
<ol>
<li>Unzip all files into a directory of your choice leaving the directory structure unchanged.</li>
</ol>
<h2>To Run:</h2>
<p>Simply type the following below at a command line
or double click on the jar or exe file in Windows.</p>
<pre><code>java -jar jGnash2.jar
</code></pre>
<h3>OpenJDK Tips:</h3>
<p>If you are using the OpenJDK, enabling OpenGL acceleration can significantly improve
graphics performance. See the integrated help for use of the <code>-opengl</code> option.</p>
<h3>Linux Tips:</h3>
<p>jGnash is not compatible with the GCJ Java installation pre-installed on older Linux distributions.
You will need to install the OpenJDK or Oracle Java Platform and correctly set the default for jGnash
to operate correctly.</p>
<h3>Mac OS X Installation:</h3>
<p>For Mac OS X users, a minimum of Mac OS X 10.7 is required unless you want to experiment with the SoyLatte Java distribution.</p>
<ol>
<li>Copy the jGnash folder to <code>/Applications</code>.</li>
<li>Open AppleScript Editor.</li>
<li>
<p>Create the following script:</p>
<pre><code>try
do shell script "/System/Library/Frameworks/JavaVM.framework/Versions/ 1.7.0/Home/bin/java -classpath /Applications/jGnash/lib -jar /Applications/jGnash/jgnash2.jar"
end try
</code></pre>
</li>
<li>
<p>Save it as an Application called <code>jGnash.app</code> in <code>/Applications/jGnash</code></p>
</li>
</ol>
<h3>NOTES:</h3>
<p>When upgrading from 1.x to 2.x, you will have to recreate your reminders.</p>
<p>See the integrated help for command line options.</p>
<h2>Building jGnash:</h2>
<p>To build jGnash you'll need the following software installed on your system:</p>
<ol>
<li><a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">JDK 8</a> or later.</li>
<li><a href="http://ant.apache.org">Apache Ant</a> 1.7.0 or later</li>
<li><a href="http://maven.apache.org">Apache Maven</a> 3.0 or later</li>
</ol>
<p>Before running the main build, the Maven-based <code>jgnash-help</code> project
must be built and installed into your local Maven repository:</p>
<pre><code>cd jgnash-help
mvn install
</code></pre>
<p>To create the distribution zip file, return to the main directory (<code>cd ..</code>) and then run:</p>
<pre><code>mvn package
</code></pre>
<p>The distribution zip file will be produced at <code>jgnash-swing/target/jgnash-</code><em>version</em><code>-bin.zip</code>.</p>
</body>
</html>