Beautiful README
This commit is contained in:
parent
7c33c5eb27
commit
d2c562885e
52
README.md
52
README.md
|
@ -1,5 +1,51 @@
|
||||||
# poweroffer
|
# PowerOffer
|
||||||
|
|
||||||
this simple program will allow you to not procrastinate and to have a break from the PC during the day :)
|
<p align="center">
|
||||||
|
<br>
|
||||||
|
<a href="https://github.com/archnotwindows/poweroffer/">
|
||||||
|
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/archnotwindows/poweroffer?logo=github">
|
||||||
|
</a>
|
||||||
|
<a href="https://github.com/archnotwindows/poweroffer/issues">
|
||||||
|
<img alt="Issues" src="https://img.shields.io/github/issues/archnotwindows/poweroffer?logo=github">
|
||||||
|
</a>
|
||||||
|
<a href="https://github.com/archnotwindows/poweroffer/pulls">
|
||||||
|
<img alt="Pull requests" src="https://img.shields.io/github/issues-pr/archnotwindows/poweroffer?logo=github">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
<br>
|
||||||
|
<a href="https://github.com/archnotwindows/poweroffer/fork">
|
||||||
|
<img alt="Forks" src="https://img.shields.io/github/forks/archnotwindows/poweroffer?logo=github">
|
||||||
|
</a>
|
||||||
|
<a href="https://img.shields.io/github/stars/archnotwindows/poweroffer">
|
||||||
|
<img alt="Stars" src="https://img.shields.io/github/stars/archnotwindows/poweroffer?logo=github">
|
||||||
|
</a>
|
||||||
|
|
||||||
to see all the installation steps check the wiki session of this repository :)
|
Poweroffer is a small and simple Python program that is used to remove distractions (like Youtube) and not procrastinate.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
- Install **[Python](https://python.org)** on your machine. **Version 3.10 or higher is required!**
|
||||||
|
- Clone the repository on your machine.
|
||||||
|
- Open your console in the cloned repository.
|
||||||
|
- To complete the installation, write the following command in the console:
|
||||||
|
```console
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
- To start Poweroffer, write the following command in the console:
|
||||||
|
```console
|
||||||
|
python main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under either of:
|
||||||
|
- [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html)
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
[![gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=Gmail&logoColor=white)](mailto:)
|
||||||
|
[![github](https://img.shields.io/badge/GitHub-000000?style=for-the-badge&logo=GitHub&logoColor=white)](https://github.com/archnotwindows)
|
||||||
|
[![twitter](https://img.shields.io/badge/Twitter-007fff?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/Lollopro59_)
|
||||||
|
[![instagram](https://img.shields.io/badge/Instagram-8f00ff?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/lollog020406/)
|
||||||
|
[![stackoverflow](https://img.shields.io/badge/StackOverFlow-FF8000?style=for-the-badge&logo=stackoverflow&logoColor=white)](https://stackoverflow.com/users/)
|
||||||
|
|
Loading…
Reference in New Issue