docgen

README

<!-- gen-readme start - generated by https://github.com/jetify-com/devbox/ -->

{{- if .Name }}
# {{ .Name }}
{{ end }}

{{- if .Description }}
{{ .Description }}
{{ end }}
## Getting Started
This project uses [devbox](https://github.com/jetify-com/devbox) to manage its development environment.

Install devbox:
```sh
curl -fsSL https://get.jetpack.io/devbox | bash
```

Start the devbox shell:
```sh 
devbox shell
```

Run a script in the devbox environment:
```sh
devbox run <script>
```

{{- if .Scripts }}
## Scripts
Scripts are custom commands that can be run using this project's environment. This project has the following scripts:
{{ range $name, $_ := .Scripts }}
* [{{ $name }}](#devbox-run-{{ $name }})
{{- end }}
{{ end }}

{{- if .EnvVars }}
## Environment

```sh
{{- range $key, $value := .EnvVars }}
{{ $key }}="{{ $value }}"
{{- end }}
```
{{ end }}

{{- if .InitHook }}
## Shell Init Hook
The Shell Init Hook is a script that runs whenever the devbox environment is instantiated. It runs 
on `devbox shell` and on `devbox run`.
```sh
{{ .InitHook }}
```
{{ end }}

{{- if .Packages }}
## Packages
{{ range .Packages }}
* {{ if .DocsURL }}[{{ .Raw }}]({{ .DocsURL }}){{ else }}{{ .Raw }}{{ end }}
{{- end }}
{{ end }}

{{- if .Scripts }}
## Script Details
{{ range $name, $commands := .Scripts }}
### devbox run {{ $name }}
{{- if .Comments }}
{{ .Comments }}
{{-  end }}
```sh
{{ $commands }}
```
&ensp;
{{ end }}
{{ end }}

<!-- gen-readme end -->

Documentation

Index

• func GenerateReadme(devbox *devbox.Devbox, outputPath, templatePath string) error
• func SaveDefaultReadmeTemplate(outputPath string) error

Functions

func GenerateReadme

func GenerateReadme(
	devbox *devbox.Devbox,
	outputPath, templatePath string,
) error

func SaveDefaultReadmeTemplate

func SaveDefaultReadmeTemplate(outputPath string) error