Compare commits

...

3 Commits

@ -1,6 +1,23 @@
# cookiecutter-basic
A basic cookiecutter template for most Androiddrew style repos.
A basic [Cookiecutter](https://cookiecutter.readthedocs.io/en/stable) template for most Androiddrew style repos.
## Usage
With [Cookiecutter installed](https://cookiecutter.readthedocs.io/en/stable/installation.html), execute the following command and provide your template parameters.
```
cookiecutter https://git.runcible.io/androiddrew/cookiecutter-basic
```
Once templated, you can change into the new project directory and execute the `scripts/bootstrap.sh` script.
```
cd <cookiecutter.project_slug>
./scripts/bootstrap.sh
```
This will create a Python virtual environment if one is not already enabled, install [pip-tools](https://github.com/jazzband/pip-tools/), compile the requirements.in and dev-requirements.in files, install the initial dependencies, initialize the project as a git repository, and install the [pre-commit hooks](https://pre-commit.com/).
## Licenses
@ -10,4 +27,4 @@ Example:
```
[project]
license = {text = "MIT"}
```
```

Loading…
Cancel
Save