Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Keats committed Dec 13, 2024
1 parent 086a0f6 commit 3301561
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ Run `kickstart --help` for a full listing of the available commands and their fl
- It has conditional cleanup to not let irrelevant files in the output directory after generation
- Templates can be made for any kind of projects/languages
- Case conversion filters, e.g. `camelCase` to `CamelCase`
- Pre-gen and post-gen hooks that can execute templated scripts

The main drawback compared to cookiecutter is the lack of hook scripts support, which can be mitigated a bit by the conditional cleanup.

Lastly, since Windows does not allow `|` in file paths, you may use a [tera built-in filter][builtin]
Since Windows does not allow `|` in file paths, you may use a [tera built-in filter][builtin]
by using the `$$` separator instead.

Note that, in file templates, you should keep using `|` for filtering, as the `$$` syntax is only for files and directories.
Expand Down Expand Up @@ -75,6 +74,9 @@ authors = [

]

# Whether to follow the symlinks when going through the files in the template
follow_symlinks = false

# Optional, a list of keywords for this template
keywords = [

Expand Down Expand Up @@ -228,14 +230,15 @@ You can use these like any other filter, e.g. `{{variable_name | camel_case}}`.

## Changelog

### 0.5.0 (unreleased)
### 0.5.0 (2024-12-13)

- The `sub-dir` parameter has been renamed to `directory` in the CLI
- Templates with a `directory` field will now no longer include that directory name in the output
- `copy_without_render` elements are now templated and refer to the template relative path if specified
- Avoid path traversals in cleanup
- Add pre-gen and post-gen hooks
- Force `output-dir` to be selected in the CLI to avoid surprises
- Add support for following symlinks

### 0.4.0 (2023-08-02)

Expand Down

0 comments on commit 3301561

Please sign in to comment.