diff --git a/README.md b/README.md index 7e367b3..625ded5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # Poetry Python 🐍 Project Template This repository is a template for a python 🐍 project using the poetry container. The intent is to do all the basic lifting for a python project so that people can hit the ground running with their ideas. +### To make this project your own +1. Create a new repository, [using this one as a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template). +2. Change the `project` folder name to the kebab-case name of your project. +3. Update the `BASE_DIR` variable value in the `Makefile` with the kebab-case name of your project. +4. Update the information in the `pyproject.toml` file with your project's and your personal information. +5. Update the information in the `CODEOWNERS` file so that it uses your GitHub ID and the kebab-case name of your project folder. + ### 🐍 by Default (Feel free to delete this after creating your project) - [Black](https://github.com/psf/black): This serves as the codebase formatter. - [Pylint](https://www.pylint.org/): This serves as the codebase linter. diff --git a/.pylintrc b/pylintrc similarity index 100% rename from .pylintrc rename to pylintrc