Merge pull request #540 from realpython/readme-python-project

Sample materials for the article on `README` files

Author: brendaweles

readme-python-project/README-template.md

@@ -0,0 +1,106 @@
+# Project's Name
+
+![coverage](https://img.shields.io/badge/coverage-80%25-yellowgreen)
+![version](https://img.shields.io/badge/version-1.2.3-blue)
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
+
+< A short description of what your project does >
+
+< Add an optional screenshot of your project below >
+
+![]()
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [Execution / Usage](#execution-usage)
+- [Technologies](#technologies)
+- [Features](#features)
+- [Contributing](#contributing)
+- [Contributors](#contributors)
+- [Author](#author)
+- [Change log](#change-log)
+- [License](#license)
+
+## Installation
+
+On macOS and Linux:
+
+```sh
+$ pip install <project-name>
+```
+
+On Windows:
+
+```sh
+PS> pip install <project-name>
+```
+
+## Execution / Usage
+
+To run < project's name >, fire up a terminal window and run the following command:
+
+```sh
+$ <project>
+```
+
+Here are a few examples of using the < project's name > library in your code:
+
+```python
+from project import Project
+
+...
+```
+
+For more examples, please refer to the project's [Wiki](wiki) or [documentation page](page).
+
+## Technologies
+
+< Project's name > uses the following technologies and tools:
+
+- [Python](https://www.python.org/): ![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+- [SQLite](https://sqlite.org/): ![SQLite](https://img.shields.io/badge/sqlite-%2307405e.svg?style=for-the-badge&logo=sqlite&logoColor=white)
+- ...
+
+## Features
+
+< Project's name > currently has the following set of features:
+
+- Support for...
+- ...
+
+## Contributing
+
+To contribute to the development of < project's name >, follow the steps below:
+
+1. Fork < project's name > from (<https://github.com/yourusername/yourproject/fork>)
+2. Create your feature branch (`git checkout -b feature-new`)
+3. Make your changes
+4. Commit your changes (`git commit -am 'Add some new feature'`)
+5. Push to the branch (`git push origin feature-new`)
+6. Create a new pull request
+
+## Contributors
+
+Here's the list of people who have contributed to < project's name >:
+
+- John Doe – [@JohnDoeTwitter](https://twitter.com/< username >) – [email protected]
+- Jane Doe – [@JaneDoeTwitter](https://twitter.com/< username >) – [email protected]
+
+The < project's name > development team really appreciates and thanks the time and effort that all these fellows have put into the project's growth and improvement.
+
+## Author
+
+< Author's name > – [@AuthorTwitter](https://twitter.com/< username >) – [email protected]
+
+## Change log
+
+- 0.0.1
+    * First working version
+- 0.0.2
+    - Polish the user interface
+- ...
+
+## License
+
+< project's name > is distributed under the < license > license. See [`LICENSE`](LICENSE.md) for more details.

readme-python-project/README.md

@@ -0,0 +1,3 @@
+# Creating Great README Files for Your Python Projects
+
+This folder provides the code examples for the Real Python tutorial [Creating Great README Files for Your Python Projects](https://realpython.com/readme-python-project/).