diff options
| author | vaxerski <43317083+vaxerski@users.noreply.github.com> | 2022-04-19 13:39:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-19 13:39:20 +0200 |
| commit | c482e0ddc3f289f78524de3ace85b1cb648ca70f (patch) | |
| tree | 35707181e8b2be69342c9e2ee0c63ee4beeafeca /docs | |
| parent | c7d02a38d9527b4a1190102786e3d2cc75d4c84c (diff) | |
| parent | 63cf99d819784fbd2d12a9574b62b7be4f0bc366 (diff) | |
Merge pull request #44 from ElectronicsArchiver/main
Documentation Rework
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Contribute.md | 29 | ||||
| -rw-r--r-- | docs/Install.md | 35 |
2 files changed, 64 insertions, 0 deletions
diff --git a/docs/Contribute.md b/docs/Contribute.md new file mode 100644 index 00000000..c921ce40 --- /dev/null +++ b/docs/Contribute.md @@ -0,0 +1,29 @@ + +# Contributing + +*Thank you for considering contributing to Hyprland.* + +## Development + +Check the [Wiki] for debugging instructions. + +Afterwards, pick yourself an [Issue] or implement your own suggestion. + +*As Hyprland is still in its early stages of development, I'd recommend you stick to bug fixes first.* + +## Pull Requests + +- Please follow the code style + +- Code must be readable + +- Features should be useful + +- Test your changes! + + *Run it on bare metal and check if everything works.* + +<!-----------------------------------------------------------------------------> + +[Issue]: https://github.com/vaxerski/Hyprland/issues +[Wiki]: https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging diff --git a/docs/Install.md b/docs/Install.md new file mode 100644 index 00000000..2b8c3a7e --- /dev/null +++ b/docs/Install.md @@ -0,0 +1,35 @@ + +# Installation + +## Packages + +*I do not maintain any packages, but some kind people have made them for me.* + +**If I missed any, please let me know.** + +## Notice + +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.*** <br> +*If they don't work, try building manually.* + +#### Arch ( AUR / -git ) + +```sh +yay -S hyprland-git +``` + +--- + + +## Building + +If your distro doesn't have **Hyprland** in its repositories, or you want to modify it, please refer to the **[Wiki Page][Install]** for the installation instructions. + + +<!-----------------------------------------------------------------------------> + +[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation + + |
