mirror of
https://github.com/NotAShelf/Hyprdoctor.git
synced 2024-11-22 13:20:48 +00:00
docs: initialize readme
This commit is contained in:
parent
63f6943477
commit
07d15d896d
1 changed files with 14 additions and 0 deletions
14
README.md
Normal file
14
README.md
Normal 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.
|
Loading…
Reference in a new issue