27 lines
574 B
Markdown
27 lines
574 B
Markdown
|
{% set is_open_source = cookiecutter.open_source_license != 'Not open source' -%}
|
||
|
|
# {{ cookiecutter.project_name }}
|
||
|
|
|
||
|
|
{{ cookiecutter.project_short_description }}
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
This project can be installed using pip:
|
||
|
|
|
||
|
|
```
|
||
|
|
pip install git+{{ cookiecutter.project_url }}.git
|
||
|
|
```
|
||
|
|
|
||
|
|
{% if is_open_source %}
|
||
|
|
## License
|
||
|
|
|
||
|
|
This project if a free software released under the {{ cookiecutter.open_source_license }}.
|
||
|
|
{% endif %}
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
- {{ cookiecutter.full_name }}
|
||
|
|
|
||
|
|
## Security
|
||
|
|
|
||
|
|
If you discover a potential security issue in this project, please contact {{ cookiecutter.email }}.
|