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

added linux-release, more readme

Browse Source
This commit is contained in:
Kevin Offet
2023-04-16 01:35:28 -04:00
parent 5364bfaa8a
commit 7680b34aca
2 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -9,24 +9,30 @@ Use scaffold to setup a new project with a directory skeleton of your design, an
- A new project directory is created
- Your project skeleton/template is copied from your config/projectType/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
- And if you enable them
- a git repository is initialized in the project directory
- a remote repository is created and setup
- a gitea repository is created and setup
## Installation
1 - Grab a version for your system from the releases page.
2 - Put it in a directory that is on your path.
3 - now configure your preferred setups/layouts/skeletons/templates for your projects.
1. Grab a version for your system from the releases page.
2. Put it in a directory that is on your path.
3. Now configure your preferred setups/layouts/skeletons/templates for your projects.
## Configuration
On linux the configuration directory will be at /home/user/.config/devel/scaffold
On linux, the configuration directory will be at /home/user/.config/devel/scaffold
For the windows versions, you might want to look at your User_Configuration_Directories location, and change it according to your needs. On windows it's value is the %APPDATA% environment variable.
In a PowerShell, use `Get Child-Item Env:` to display all the environment variables.
Then `[Environment]::SetEnvironmentVariable("APPDATA","C:\Users\You\Wherever-you-like\","User")` to set the new value.
It's a little simpler at a command prompt -- type the command `set` and hit `Enter`. See what `APPDATA` is currently set to. Change it with `setx APPDATA "C:\Users\You\SomeWhere"`.
The examples directory contains an example-scaffold-projectType.toml configuration file. Place a copy in each projectType directory, adjusted to your preferences per the given project type.
## The `scaffold` command
| Command | Description |