aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorElectronicsArchiver <[email protected]>2022-04-18 17:34:18 -0400
committerElectronicsArchiver <[email protected]>2022-04-18 17:34:18 -0400
commit8c4a5104cf37fc89d4f522e37970054d1d69e1a0 (patch)
treee0715610eda662530278561e2e303fe750f3985b /docs
parent2de32ec5c552fc64b5b5fc0432e6371255f6143c (diff)
downloadHyprland-8c4a5104cf37fc89d4f522e37970054d1d69e1a0.tar.gz
Hyprland-8c4a5104cf37fc89d4f522e37970054d1d69e1a0.zip
Moved Install / Contribute To Docs
Diffstat (limited to 'docs')
-rw-r--r--docs/Contribute.md38
-rw-r--r--docs/Install.md15
2 files changed, 53 insertions, 0 deletions
diff --git a/docs/Contribute.md b/docs/Contribute.md
new file mode 100644
index 00000000..b5fb80ff
--- /dev/null
+++ b/docs/Contribute.md
@@ -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
diff --git a/docs/Install.md b/docs/Install.md
new file mode 100644
index 00000000..71abd1a9
--- /dev/null
+++ b/docs/Install.md
@@ -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/>
+