/ 
App-InvestSim-v1.0.1
River stage zero No dependents
/ README

InvestSim - Simulateur d'investissement locatif

DESCRIPTION

A Perl/Tk application to simulate the return of a rental property investment. This is tuned for French taxes and benefits and, given that, the application is entirely localized in French.

PRE-BUILT BINARIES

You can download a pre-built Windows binary from the GitHub release page of the project. That binary is a self-installing archive. On the first run it will unzip itself in a temporary folder, so that first run is quite slow. Subsequent runs are faster to launch.

AUTOMATED INSTALLATION FROM CPAN

Install with:

sudo apt-get install perl make tcl tk tcllib tklib
cpan App::InvestSim

If this is the first time you run `cpan`, just select `auto` for the configuration and select `sudo` as the installation mode if you want to install for all users.

And then run the program with:

investment_simulator

MANUAL INSTALLATION FROM SOURCE

REQUIREMENTS

# You probably already have these 3 programs.
sudo apt-get install perl make git

# You need tcl/tk installed for the GUI of the program
sudo apt-get install tcl tk tcllib tklib

# These Perl modules are needed too, but they are installed
# automatically if you install the program with cpan:
cpan Tkx CLDR::Number File::HomeDir File::ShareDir File::ShareDir::Install

If this is the first time you run `cpan`, just select `auto` for the configuration and select `sudo` as the installation mode if you want to install for all users.

INSTALLATION

Once you have the requirements above installed, you can run the following commands to install the program:

git clone https://github.com/mkende/investment_simulator.git
cd investment_simulator
perl Makefile.PL
make
sudo make install

DISTRIBUTION

Creating a self installing Windows binary

If you have a working Windows Perl and TCL/Tk installation, you can create a self installing binary using the Par-Packer module:

pp -o investment_simulator.exe -c -x -A pp_includes.txt -I lib --link=C:\TclTk\8.6.9\bin\zlib1.dll script\investment_simulator --gui -M CLDR::Number::Role::Format -cd par.cache -a res\icon.ico;res\icon.ico

The pp_includes.txt file should contain the following content (of course, the path should be fixed for the version of TCL, Tk, and tklib that you have installed):

C:\TclTk\8.6.9\bin\tcl86.dll;tcl\bin\tcl86.dll
C:\TclTk\8.6.9\bin\tk86.dll;tcl\bin\tk86.dll
C:\TclTk\8.6.9\lib\tcl8;tcl\lib\tcl8
C:\TclTk\8.6.9\lib\tcl8.6;tcl\lib\tcl8.6
C:\TclTk\8.6.9\lib\tk8.6;tcl\lib\tk8.6
C:\TclTk\8.6.9\lib\tklib0.6\tooltip;tcl\lib\tooltip