Merchant of Venice, 0.8beta - wip

Copyright (C) 2003-19, Andrew Leppard (andrew venice org nz)
This fork is being maintained by Fabio Godoy (fabio dot godoy at me dot com) since 2021

See COPYING.txt for license terms.

1. Introduction

Thank you for trying Merchant of Venice (Venice).

Venice is a stock market trading program that supports portfolio management, charting, technical analysis, paper trading and experimental methods like genetic programming. Venice runs in a graphical user interface with online help and has full documentation. Venice runs on UNIX, including Mac OS X and Windows.

2. Running

To run Venice you will need Java J2SE JRE 8 or higher, available from the following location:

    https://www.oracle.com/java/technologies/javase-jre8-downloads.html

If you want to connect to a MySQL database you will need the database software which is available here:

    http://www.mysql.com

Venice includes a copy of a MySQL JDBC driver for your convenience. Venice allows you to access stock quotes through an internal database (hsqldb) which should require no configuration on your part.

Once they are set up, you can run Venice by typing from the command prompt:

    sh venice.sh

Or in Windows by clicking on the "venice.jar" file. Or in Mac OS X by clicking on the "Venice.app" file.

3. Contained technology

Venice contains the following technologies

HSQLDB V2.7.2 from http://hsqldb.sourceforge.net
Jython V2.1 from http://www.jython.org
MySQL Connector/J V5.1.49 from http://www.mysql.com
Joone V1.2.1 from http://www.jooneworld.com

4. Bug Reports and Enhancements

Please report any bugs that you encounter via the GitHub issues tracking system at:

https://github.com/oldpocket/venice/issues

If you have any ideas for enhancements, please document them also via the GitHub issues tracking system at:

https://github.com/oldpocket/venice/issues

Or if you have any comments, please don't hesitate to email me, Fabio Godoy (fabio dot godoy at me dot com).

5. Building

To build Venice you will need to download a copy of the source. You can download the source release which contains the source from the latest release. Alternatively, you can download the current development version from GitHub by running the following command:

git clone https://github.com/oldpocket/venice.git

To build Venice you will need the programmes listed in the "Running" section and the following:

Ant 1.5 or higher
    http://jakarta.apache.org/builds/jakarta-ant/release/v1.5/

To run the unit tests you will need:

JUnit 3.8.1 or higher
    http://www.junit.org/

To build Venice type the following:

ant build

You can then run Venice by either:

ant run

Or by creating a jar (ant jar) and then running Venice as described above.

The build file (build.xml) provides other functions for developers (some of these will only work from source checked out from Github):

• api Generate a javadoc API of the code
• app Generate a Mac OS X Venice application
• backup (Not Working) Pulls a backup copy of the git tree from Github and stores it in the backup directory
• clean Removes all built and temporary files
• doc Builds the documentation
• jar Create a java archive file for Venice
• locale Check locale files for consistency
• release Packages Venice into a file ready for release
• test Runs the automated test suite
• web Packages the web files ready for deployment (Not included in the source release).

6. Licenses

• Venice is Copyright (C) 2003-2012, Andrew Leppard.
• Venice fork is Copyright (C) 2021-today, Fabio Godoy.
• HSQLDB is Copyright (C) 1995-2000, The Hypersonic SQL Group.
• Joone is Copyright (C) 2004, Paolo Marrone and the Joone team.
• Jython is Copyright (C) 2000, Jython Developers.