See INSTALL for installation instructions

FreeEMS-Tuner was written by Aaron Barnes <aaron.barnes@hbcosmo.com>

Once installed using the instructions in INSTALL, to run the program
simple navigate to the freeems-tuner directory and type into the prompt:

    python main.py

And you are away!



Basic layout of program directory:

freeems-tuner_version/
    comms/
        Contains comms plugins for connecting to hardware
        Released plugins include:

        Serial.py
            Basic serial communications
        Test.py
            Debugging connection
            
        protocols/
            Contains protocol plugins for communicating with hardware
            Released plugins include:

            IFreeEMS_Vanilla/v0_0_1/

    data/
        Contains per-user settings and log files

        my_config.ini
            User overrided config.

        my_config.cached.ini
            System file used for storing internal settings

        app.log
            Application log

    docs/
        Documentation

    gui/
        Contains GUI code

    libs/
        Internal and external libraries. External libraries are included in release
        for compatibilty and ease of installation

        config.py
            Handle loading of configuration

        data.py
            Handles creation/manipulation of the data directory

        gui.py
            All gui code. To be divided up into plugins

    config.default.ini
        Default configuration. Do not edit this file, but rather override settings in
        data/my_config.ini - REMEMBER to include headings!! e.g. [Logging]

    main.py
        Boot/setup file
    

You many notice many *.pyc files appear, these are files generated by python to speed up the program,
you can safely ignore them. If they are deleted, python will regenerate them next time it is run.