File	Date	Author	Commit
aux_files	2025-05-02	Nune Badalyan	[8daf4a] Release v2.8
cmake	2025-08-25	nune	[2714e4] * Release v2.11.2
examples	2025-10-26	nune	[1273ba] Release 2.17.4.
nls	2025-10-26	nune	[1273ba] Release 2.17.4.
res	2025-08-28	nune	[54dd69] * Release v2.12.1
src	2025-10-26	nune	[1273ba] Release 2.17.4.
tst	2025-10-24	nune	[cf718c] Release v2.17.3
utils	2025-06-06	Lilit Khechoyan	[107de2] - Updated makefiles to mute errors from quickjs.
CMakeLists.txt	2025-10-26	nune	[1273ba] Release 2.17.4.
Changelog	2025-10-26	nune	[1273ba] Release 2.17.4.
Copyright	2024-11-21	Nune Badalyan	[446d03] - Added LICENSE, WARRANTY and Copyright files t...
Doxyfile	2025-10-26	nune	[1273ba] Release 2.17.4.
LICENSE	2024-11-21	Nune Badalyan	[446d03] - Added LICENSE, WARRANTY and Copyright files t...
README	2025-10-26	nune	[1273ba] Release 2.17.4.
Release_notes.txt	2025-10-26	nune	[1273ba] Release 2.17.4.
WARRANTY	2024-11-21	Nune Badalyan	[446d03] - Added LICENSE, WARRANTY and Copyright files t...
application_generator	2025-08-19	Lilit Khechoyan	[1546eb] - Release v2.10.66
makefile	2025-10-26	nune	[1273ba] Release 2.17.4.
startup.tcl	2025-08-19	Lilit Khechoyan	[1546eb] - Release v2.10.66
tutorial.mp4	2024-09-25	nune	[d104c9] Added video-tutorial on project usage.

Read Me

Introduction

        This is the README file of Application Generator Version 2.17.4.  

CONTENTS
        1. Getting Started

        2. Prerequisites

        3. Directory Content

        4. Compilation

        5. Installation

        6. Usage

1. Getting Started

        The Application Generator generates source and header files for a 
        desired database and corresponding publishing source/header files for 
        Instigate Framework.

        "Application Generator" allows user to design his/her own Application 
        based on Instigate Application Framework and later export source code 
        for the created Application sources. 

2. Prerequisites

        a) Application Framework
                - Download Instigate Application Framework from SourceForge:
                  https://sourceforge.net/p/instigate-fwk/code/ci/master/tree/
                  Use the git clone command inscribed near HTTPS access.

                - Install Application Framework prerequisites (see README of the
                  installed Application Framework).

3. Directory Content

        - application_generator
        - nls
        - startup.tcl
        - Doxyfile
        - README
        - res
        - makefile
        - utils
        - cmake
        - src

4. Compilation

Compile the package as follows:
        a) Configure build parameters by issueing'make setup' command specifying:
                - release or debug build (default is debug):
                        make setup build_type=<release | debug>
                - static or dynamic linking (default is dynamic):
                        make setup link_type=<static | dynamic>
                - enable using sdk:
                        make setup use_sdk=yes
                - set sdk path:
                        make setup sdk_path = /your/sdk/path (default is /tmp/instigate-software/gnu_system/3.2/x86_64)

        Note 1: all options should be specified during a single 'make setup' command

        b) Build the library using 'make' command.
           Multi-threaded build is supported, e.g. "make -j4" will run 4 parallel
           threads if you are running it on a quad-cpu computer

Additional features:

        a) For built the project with documentation use following command:
                - make all
           The generated documentation will be available in the 'doc' directory.

        b) Cleanup results of previous build via 'make clean' command

5. Installation

        Use 'make install' command which will install the package under the
        directory specified by the variable 'install path'. The variable is
        define in the top level makefile and defaults to
        $(prefix)/application_generator/2.17.4/<arch>(or <arch>_debug if build type is debug)

6. Usage

        To run the application use:
        ./application_generator command.

        If you need to run some tcl project use:
        ./application_generator -t "file_name.tcl" command