Skip to content

Commit

Permalink
Add info about the version field
Browse files Browse the repository at this point in the history
  • Loading branch information
Mirch authored May 2, 2024
1 parent aff74ce commit 2c40e5f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,12 @@ pont build --name <template-name> --from <source>
## How does it work?

Pont creates a `pont.yaml` file when you initialize a new project, which it then consumes during the build process.
A `pont.yaml` file contains 3 fields: the template's name (which will be replaced by your project name), a list of commands that will be run when the project is built, and a list of ignored files (which will not get their name or content replaced).
A `pont.yaml` file contains 4 fields:
- the `pont` version used for the template (the local `pont` version should match this).
- the template's name (which will be replaced by your project name);
- a list of commands that will be run when the project is built;
- a list of ignored files (which will not get their name or content replaced).

It is a good idea to always include the `.git` directory in the `ignore` list, as attempting to rewrite any of the files inside it might corrupt your Git repository.

`pont.yaml` example:
Expand Down

0 comments on commit 2c40e5f

Please sign in to comment.