21 lines
1.2 KiB
Markdown
21 lines
1.2 KiB
Markdown
# scaffold
|
|
|
|
## Intro
|
|
Use scaffold to setup a new project with a directory skeleton of your design, and if you'd like, it can also initialize local and remote git repositories of the new project for you.
|
|
|
|
## 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 it for 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 into a GITIGNORE file 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.
|
|
|
|
## 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
|