ProvideX Project

All ProvideX projects have a common structure with several folders and files that must exist for the plug-in to recognize and work with the project.

Folder Structure

A ProvideX project will include two sub-folders:

Source Folder

All source files for the project will be placed in the source folder.

The default name used for this folder is src; this value can be overridden when creating a new ProvideX project or adding ProvideX to an existing project.

Output Folder

The compiled version of the source files are placed in the output folder.

This folder will be created, if necessary, when building (or compiling) the source files. The sub-folder structure of this folder will mirror the sub-folder structure of the source folder. When using a version control system, do not check in this folder.

The default name for the output folder is compiled; this value can be overridden when creating a new ProvideX project or adding ProvideX to an existing project.

Other Files

Every project will have several other files in the root folder of the project; not all of the files are required.

.project

This is an Eclipse control file used to describe information about the project and is created automatically when creating a new ProvideX project or adding ProvideX to an existing project.

This file is required and should be checked in to a version control system.

project.BuildTagInfo.properties

This is a special file used by the ProvideX plug-in to save properties for each file in the project. This file will be created and managed by the ProvideX plug-in when the 'Load/Save resource properties in "project.BuildTagInfo.properties" file' Build Options preference is enabled.

This file is optional and should be checked in to a version control system.

project.properties

This is a special file used by the ProvideX plug-in to set default and override values for common file properties and project preferences.

This file is optional and should be checked in to a version control system.

PVXProjectName.INI

This file is created by the wizard used to create a ProvideX project or tp add ProvideX to an existing project. The ProjectName part of this file name will be replaced with the actual name of the project.

This file is required and should be checked in to a version control system.


Next Section: ProvideX Editor