diff --git a/TODO.md b/TODO.md index c8e6121..0b026f6 100644 --- a/TODO.md +++ b/TODO.md @@ -1,6 +1,5 @@ # TODO: -- readme +- generate gitea project - tests -- pyenv -- mypy/black/etc +- add AGPL diff --git a/{{ cookiecutter.project_slug }}/.python-version b/{{ cookiecutter.project_slug }}/.python-version new file mode 100644 index 0000000..3e72e17 --- /dev/null +++ b/{{ cookiecutter.project_slug }}/.python-version @@ -0,0 +1 @@ +{{ cookiecutter.python_min_version }} diff --git a/{{ cookiecutter.project_slug }}/README.md b/{{ cookiecutter.project_slug }}/README.md new file mode 100644 index 0000000..a718cc6 --- /dev/null +++ b/{{ cookiecutter.project_slug }}/README.md @@ -0,0 +1,26 @@ +{% 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 }}. diff --git a/{{ cookiecutter.project_slug }}/SECURITY.md b/{{ cookiecutter.project_slug }}/SECURITY.md new file mode 100644 index 0000000..cd89d47 --- /dev/null +++ b/{{ cookiecutter.project_slug }}/SECURITY.md @@ -0,0 +1,3 @@ +# Reporting a Vulnerability + +If you discover a potential security issue in this project, please contact {{ cookiecutter.email }}.