https://github.com/jrieke/readme-template
My template for Github readmes
https://github.com/jrieke/readme-template
Last synced: 3 months ago
JSON representation
My template for Github readmes
- Host: GitHub
- URL: https://github.com/jrieke/readme-template
- Owner: jrieke
- License: mit
- Created: 2021-05-05T19:53:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-05T20:55:24.000Z (over 4 years ago)
- Last Synced: 2025-07-14T08:21:26.766Z (3 months ago)
- Size: 1.83 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sample project 👻
[](https://shields.io/)
**This one sentence explains your project in simple words.**
Add some more description of your project here. Try to keep it short but explain most features. Two to four lines of text are usually good. Link to frameworks and tools that you integrate. Some more text and more text and more text and more text and more text and more text and more text and more text and more text.
If needed: Alpha/Beta version, use with care.
---
🎉 Try it out 🎉
---
## Installation
```bash
pip install sample-package
```
You can add some more detailed instructions here. Don't forget to mention any special dependencies.
## How to use it
```python
import sample_package
sample_package.do_something()
sample_package.do_something_else()
```
Add some description of what will happen. Or an image. Or the terminal output of the command above. One to three paragraphs of text is a good guideline here. Ideally, the user should be able to run a simple example with this instruction. Anything more advanced can go to the section below.
## More options
- Here's something else you can do:
```python
sample_package.super_advanced_func()
```
- Also, there's feature X.
- If you already have a lot of features, you can split this up into several sections.
## TODOs
PRs are welcome! If you want to work on any of these things, please open an issue to coordinate.
- [ ] List a few things you want to do
- [ ] The idea is to let people know where you are headed, so they can see if they want to help you
- [x] ~~If you're working on an item, you can strike it through, so people know they shouldn't start working on it~~