kevin/scaffold
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

more readme +dirtree pic

Browse Source
This commit is contained in:
Kevin Offet
2023-04-15 16:06:39 -04:00
parent aa955c3b4f
commit 1d2d293b21
3 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -4,14 +4,6 @@
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.
## 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
@@ -19,3 +11,21 @@ If you are NOT using git to track your project types and samples/skeletons/templ
- 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.