{{ project_name }}

• Blender version: {{ b3d_version }}

---

This project is:

1. A reusable folder structure,
2. suggested file naming, and
3. tools for automation (requires 1 and 2.)

• {{ project_name }}
  • Quickstart, no Git, no scripts
  • Quickstart
  • Quickstart, pt-cli
    • Customize
  • Included Utility Scripts
  • Example Folder Structure

Quickstart, no Git, no scripts

1. Download the zip, extract and rename the top-level directory
2. Adapt [[./DOC/filenaming.md]] to your requirements
3. Delete folders and files you don't need for your project

Quickstart

1. Clone this git repo
2. Copy and rename the folder according to your project
3. Ensure you have Python
4. Run the post_config script (.bat for Windows; .sh for Linux/macOS)

After initial project configuration, edit this readme for your project. Fork the template repo to customize for your organization or team.

Quickstart, pt-cli

npm i @garyr/pt-cli

pt learn https://github.com/garyritchie/pt_blender

pt init pt_blender ./path/to/MY_PROJECT

Customize

pt init pt_blender ./path/to/MY_NEW-TEMPLATE

pt config pt_blender --json > ./path/to/MY_NEW-TEMPLATE/.pt-template.json

Edit the post_config scripts, .pt-template.json, and readme.md, then:

pt learn ./path/to/MY_NEW-TEMPLATE

For more information and examples see https://github.com/garyritchie/pt-cli/blob/main/doc/usage.md

Included Utility Scripts

Python 3.x required to use the scripts in ./APP/

• python ./APP/getblender.py -h - For retrieving latest point-release. Symlinks it to your path.
• python ./APP/tasks.py -h - Work-in-progress translation of my main makefile. Relies heavily on companion .makerc or environment variables.

Example Folder Structure

Placing the template as a sibling to your organizations allows python ./APP/tasks.py update to work from within a project folder.

For example, given the structure below, doing python ./APP/tasks.py update within PROJECT_B will pull newer shell scripts from the PROJECT_TEMPLATE two levels up. An .update-exclude in the project root will prevent listed files from getting overwritten.

Project retrospective is an opportunity to migrate time-saving improvements of tools and structure back to the template.

.
├── .env
├── ORGANIZATION_ONE/
│   ├── .env
│   ├── .makerc
│   ├── PROJECT_A/
│   └── PROJECT_B/
├── ORG_THREE/
│   ├── .env
│   ├── .makerc
│   ├── PROJECT_ONE/
│   └── PROJECT_TWO/
├── ORG_TWO/
│   ├── .env
│   ├── .makerc
│   └── PROJECT_1/
└── PROJECT_TEMPLATE/