https://github.com/heaths/template-rustlang
Rust repository template
https://github.com/heaths/template-rustlang
rustlang template template-repository
Last synced: 4 months ago
JSON representation
Rust repository template
- Host: GitHub
- URL: https://github.com/heaths/template-rustlang
- Owner: heaths
- License: mit
- Created: 2022-11-09T05:53:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T15:52:24.000Z (over 1 year ago)
- Last Synced: 2025-04-19T18:26:21.708Z (about 1 year ago)
- Topics: rustlang, template, template-repository
- Language: Rust
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# {{param "name" (param "github.repo") "What is your project name?" | titlecase}}
{{if not (param "release" true "Do you want a release pipeline?") -}}
{{deleteFile ".github/workflows/release.yml"}}
{{- end -}}
{{if (param "badges" true "Do you need badges?") -}}
{{if (param "release") -}}
[![releases](https://img.shields.io/github/v/release/{{param "github.owner"}}/{{param "github.repo"}}.svg?logo=github)](https://github.com/{{param "github.owner"}}/{{param "github.repo"}}/releases/latest)
{{- end}}
[![docs](https://img.shields.io/docsrs/{{param "name"}}?logo=rust)](https://docs.rs/{{param "name"}})
[![ci](https://github.com/{{param "github.owner"}}/{{param "github.repo"}}/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/{{param "github.owner"}}/{{param "github.repo"}}/actions/workflows/ci.yml)
{{- end}}
To create a new repository from this template repository for Rust projects,
using the [GitHub CLI](https://github.com/cli/cli) run:
```bash
gh extension install heaths/gh-template
gh template clone --template heaths/template-rustlang --public
# Recommended
cd
git commit -a --amend
```
The `gh template` command will:
1. Create a new repository with the given `` on GitHub.
2. Copy the `heaths/template-rustlang` files into that repo.
3. Clone the new repository into a directory named `` in the current directory.
4. Apply built-in and passed parameters, or prompt for undefined parameters, to format template files.
This will create a new repo with the given `` in GitHub, copy the
`heaths/template-rustlang` files into that repo, and clone it into a
subdirectory of the current directory named ``.
See [heaths/gh-template](https://github.com/heaths/gh-template) for more information
about this GitHub CLI extension.
## License
Licensed under the [MIT](LICENSE.txt) license.