init
This commit is contained in:
46
.github/README.md
vendored
Normal file
46
.github/README.md
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
# zig template
|
||||
|
||||
[](https://github.com/spotdemo4/zig-template/actions/workflows/check.yaml)
|
||||
[](https://github.com/spotdemo4/zig-template/actions/workflows/vulnerable.yaml)
|
||||
[](https://nixos.org/)
|
||||
[%22&replace=%241&logo=zig&logoColor=%23bac2de&label=zig&labelColor=%23313244&color=%23F7A41D>)](https://ziglang.org/)
|
||||
|
||||
template for [zig](https://ziglang.org/)
|
||||
|
||||
part of [spotdemo4/templates](https://github.com/spotdemo4/templates)
|
||||
|
||||
## requirements
|
||||
|
||||
- [nix](https://nixos.org/)
|
||||
- [direnv](https://direnv.net/) (optional)
|
||||
|
||||
## getting started
|
||||
|
||||
initialize direnv:
|
||||
|
||||
```elm
|
||||
ln -s .envrc.project .envrc &&
|
||||
direnv allow
|
||||
```
|
||||
|
||||
or manually enter the development environment:
|
||||
|
||||
```elm
|
||||
nix develop
|
||||
```
|
||||
|
||||
### check
|
||||
|
||||
```elm
|
||||
nix flake check
|
||||
```
|
||||
|
||||
### release
|
||||
|
||||
releases are automatically created for [significant](https://www.conventionalcommits.org/en/v1.0.0/#summary) changes
|
||||
|
||||
to manually create a version bump:
|
||||
|
||||
```elm
|
||||
bumper
|
||||
```
|
||||
Reference in New Issue
Block a user