create_project Namespace Reference

Functions
	create_project (name)

Variables
	TEMPLATE_ROOT = os.path.join("RenderingEngine", "Scripts", "Templates")
	DEST_ROOT = os.path.join("UserApplications")

Function Documentation

create_project()

create_project.create_project

(

name

)

@brief Create a new Rendering Engine test/demo project.

Generates the folder structure, copies template files, and appends
'add_subdirectory()' to TestApplications/CMakeLists.txt.

@param name  Name of the project to create.

Definition at line 59 of file create_project.py.

def create_project(name):
    """
    @brief Create a new Rendering Engine test/demo project.
    
    Generates the folder structure, copies template files, and appends
    'add_subdirectory()' to TestApplications/CMakeLists.txt.
    
    @param name  Name of the project to create.
    """
    project_dir = os.path.join(DEST_ROOT, name)
    if os.path.exists(project_dir):
        print(f"Error: Project '{name}' already exists.")
        return
 
    os.makedirs(project_dir)
    copy_template(TEMPLATE_ROOT, project_dir, name)
    FILE_PATH = os.path.join(DEST_ROOT, "CMakeLists.txt")
    CMAKE_ADD_PROJECT = "\n" + "add_subdirectory(" + name + ")"
    with open(FILE_PATH, "a") as cmake_file:
        cmake_file.write(CMAKE_ADD_PROJECT)
    print(f"Created new project at {project_dir}")
 

Variable Documentation

DEST_ROOT

create_project.DEST_ROOT = os.path.join("UserApplications")

Definition at line 30 of file create_project.py.

TEMPLATE_ROOT

create_project.TEMPLATE_ROOT = os.path.join("RenderingEngine", "Scripts", "Templates")

Definition at line 29 of file create_project.py.