Moved Install / Contribute To Docs
This commit is contained in:
parent
2de32ec5c5
commit
8c4a5104cf
3 changed files with 17 additions and 16 deletions
38
docs/Contribute.md
Normal file
38
docs/Contribute.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
|
||||
# Contributing
|
||||
|
||||
*Thank you for considering contributing to **Hyprland**.*
|
||||
|
||||
<br>
|
||||
|
||||
## Development
|
||||
|
||||
Check the **[Wiki]** for debugging instructions.
|
||||
|
||||
Afterwards, pick yourself an **[Issue]** <br>
|
||||
or *implement your own suggestion!*
|
||||
|
||||
*As the **Hyprland** is still in its early stages,* <br>
|
||||
*I'd recommend you stick to bug fixes first.*
|
||||
|
||||
<br>
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- Please follow the ***code style***
|
||||
|
||||
- Code must be ***readable***
|
||||
|
||||
- **Features** should be ***useful***
|
||||
|
||||
- **Bugfixes** should ***works***
|
||||
|
||||
- ***Test your changes!***
|
||||
|
||||
*Run it on bare metal and* <br>
|
||||
*check if everything works.*
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
|
||||
[Issue]: https://github.com/vaxerski/Hyprland/issues
|
||||
[Wiki]: https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging
|
||||
15
docs/Install.md
Normal file
15
docs/Install.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# Installation
|
||||
I do not maintain any packages, but some kind people have made them for me. If I missed any, please let me know.
|
||||
|
||||
**Warning:** since I am not the maintainer, I cannot guarantee that those packages will always work and be up to date. Use at your own disclosure. If they don't, try building manually.
|
||||
|
||||
_Arch (AUR, -git)_
|
||||
```
|
||||
yay -S hyprland-git
|
||||
```
|
||||
## Manual building
|
||||
If your distro doesn't have Hyprland in its repositories, or you want to modify Hyprland,
|
||||
|
||||
please refer to the [Wiki Page][Install] for the installation instructions.
|
||||
<br/>
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue