Section 3.1 - Software Description

The software provides a number of functions: (1) Create a new project. The program creates a new set of development directories based on the selections of the user. The program assigns the project a unique identification number and save the information to a database. (2) Create formatted documentation. Upon request, the program takes the information created by the user and formats it into the project's documentation using the support programs listed below. (3) Updates project records. The program allows the user to update aspects of the documentation (such as version number and dates) and records that information into the database for later use.

Section 3.2 - Required Support Programs

This program runs using the Qt environment primarilty on Windows or Linux.

To run this system, the following programs must also be installed on the system running the program "ls_grid":
(1) MariaDB (or MySQL) database.
(2) doxygen documentation generator.
(3) Cppcheck C/C++ static analysis tool (for C/C++ projects).
(4) ldd shared library lister (Linux).
(5) Graphviz Graphical visualisation tool.
(6) tar Compression tool.
(7) Cloc Count Lines of Code tool.
(8) git distributed version control system.
(9) Dia Diagram Editor.
(10) PlantUML Diagram tool.

Section 3.3 - Basic Operation

When the program is started, the "Create & Edit" tab. The user has the option of ccreating a new project, or editing an existing program.

Section 3.3.1 - Creating a New Project

To create a new project select the "Create New Project" in the "Project/Create" selector. Once the Create function is selected, The operator fills the fields and makes selects the options relevant to the program.