Skip to content

Latest commit

 

History

History
53 lines (48 loc) · 1.44 KB

README.md

File metadata and controls

53 lines (48 loc) · 1.44 KB
Raw
.__       .__  __   
|__| ____ |__|/  |_ 
|  |/    \|  \   __\
|  |   |  \  ||  |  
|__|___|  /__||__|  
        \/

Create custom project templates with ease.

📦 Install

  1. Build from source: Zig v0.13
git clone --depth 1 https://github.com/lawrence-laz/init && cd init && zig build --release=safe
  1. Add an alias to your shell config:
alias init="/path/to/init/zig-out/bin/init -c '/path/to/init/config/'"

🔨 Create a template

  1. Create a directory for your new template:
mkdir -p config/templates/your-template-name
  1. Create template sub-directory structure and files, for example:
config/templates/your-template-name
|- src/
|   |- main.zig
|- build.zig
|- build.zig.zon

🎉 Use

mkdir my-project && cd my-project
init your-template-name

Parameters

Templates can have parameters, which are surrounded by three underscores (ex. ___name___) in file contents, file and directory names. Then they can be used by calling init with -p name=value

For example running:

init your-template-name -p name=my-project -p "description=My very own project."

Would replace:

  • from ./your-template-name/dir-___name___/ to ./dir-my-project/
  • from ./your-template-name/___name___.txt to ./my-project.txt
  • and contents of some-file.txt from This project name is ___name___ to This project name is my-project