docs: initialize readme

This commit is contained in:
raf 2023-11-30 21:50:17 +03:00
parent 63f6943477
commit 07d15d896d
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# 🔍 Hyprdoctor
> Companion utility for Hyprland that scans your Hyprland logfile for commonly encountered errors in a community
> curated errors database.
## Project Goals
**Hyprdoctor** aims to be both a companion utility and a curated issue database for Hyprland. The goal is to let experienced
and helpful community members share their experience in a well-documented matter. The curated database allows the archival
of issues, while the companion utility provides easy access to the said curate database.
## License
This project is licensed under the GPL v3 license. See [LICENSE](LICENSE) for more details.