scaffold/README.md

# scaffold

## Intro

Use scaffold to setup a new project with a directory skeleton of your design, and if you'd like, it can also automatically initialize local, remote and gitea git repositories for the new project.

## The Process

- The new project directory is created
- Your project skeleton is copied from your sample directory
- your setup/initialization commmands are run
- a git repository is initialized in the project directory
  - and if you enable it, a remote repository is created and setup

## Configuration of samples

![Example Directory Structure](assets/images/dirtree-pic.png)

The image should explain alot.

The important description goes here.

More paragraphs of stuff.

## Git

Git is available to be used as the version control system for new projects. Select/Deselect within the `scaffold-<PROJECTTYPE>.toml` file.

***Please Note*** that if you also use git to track your configuration files and sample directories, then a `.gitignore` file within your sample directory will interfere with git's ability to track your skeletons/templates properly. So, to allow for this, put what you normally would in a `.gitignore` file instead into a file named `GITIGNORE` in your sample directory. And scaffold will convert it to a `.gitignore` file within your newProject directory.

If you are NOT using git to track your project types and samples/skeletons/templates, then no problem, just place a .gitignore file within the sample directory as you would any other file.