Skip to content

Commit 819964d

Browse files
authored
Merge pull request #5 from ferreteleco/feature/add-template
Feature/add template
2 parents d9ebea5 + ded9f93 commit 819964d

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Cookiecutter project for GitHub configuration templates
2+
3+
This repository can be used for adding Github Actions and templates to an existing project.
4+
5+
## Version
6+
7+
Current version is 0.1.0 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8+
9+
Project's version should be updated, when applicable:
10+
11+
- In this very file.
12+
13+
## Usage
14+
15+
In order to start a new project, install [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) and run the following command:
16+
17+
```bash
18+
$ cookiecutter https://github.com/ferreteleco/cookie-github.git
19+
```
20+
21+
It will create the appropriate .github folder in your project directory (wherever you invoke
22+
cookiecutter).
23+
24+
NOTE: it can also be cloned using GIT over SSH, if properly configured in your account.
25+
26+
NOTE1: after the repository is downloaded, the template can be used again without downloading it
27+
again. In order to do so, simply specify template name as argument for cookiecutter:
28+
29+
```bash
30+
$ cookiecutter cookie-github
31+
```

0 commit comments

Comments
 (0)