From 8c4a5104cf37fc89d4f522e37970054d1d69e1a0 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:34:18 -0400 Subject: Moved Install / Contribute To Docs --- docs/Contribute.md | 38 ++++++++++++++++++++++++++++++++++++++ docs/Install.md | 15 +++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 docs/Contribute.md create mode 100644 docs/Install.md (limited to 'docs') 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**.* + +
+ +## Development + +Check the **[Wiki]** for debugging instructions. + +Afterwards, pick yourself an **[Issue]**
+or *implement your own suggestion!* + +*As the **Hyprland** is still in its early stages,*
+*I'd recommend you stick to bug fixes first.* + +
+ +## 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*
+ *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. +
+ -- cgit v1.2.3 From 280d8a71ca8c91b764660cb5a471bd6e96bd3629 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Mon, 18 Apr 2022 17:49:06 -0400 Subject: Formatted Installation --- docs/Install.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 46 insertions(+), 8 deletions(-) (limited to 'docs') diff --git a/docs/Install.md b/docs/Install.md index 71abd1a9..dd8aa968 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -1,15 +1,53 @@ + # 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)_ -``` +## Packages + +*I do not maintain any packages, however*
+*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 ) + +```sh 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. -
+
+ +--- + +
+ +## Building + +If your distro doesn't have **Hyprland** in its repositories,
+or you want to modify it, please refer to the **[Wiki Pages][Install]**
+for the installation instructions. + + + + +[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation + -- cgit v1.2.3 From ec76b44700b53175b910d3a7138c540a0369aa8f Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 11:20:08 +0200 Subject: rewrite parts of the docs/install --- docs/Install.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) (limited to 'docs') diff --git a/docs/Install.md b/docs/Install.md index dd8aa968..592a27f7 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -5,8 +5,7 @@ ## Packages -*I do not maintain any packages, however*
-*some kind people have made them for me.* +*I do not maintain any packages, but some kind people have made them for me.*
@@ -14,16 +13,14 @@
-### Warning +## Notice -Since I am not the maintainer, I cannot
-guarantee that those packages will
-always work and be up to date. +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.* +*If they don't work, try building manually.*
@@ -32,7 +29,6 @@ always work and be up to date. ```sh yay -S hyprland-git ``` -
--- @@ -41,9 +37,7 @@ 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 Pages][Install]**
-for the installation instructions. +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. -- cgit v1.2.3 From e01247c10cb56c0e9c1548e61f80858956f8b520 Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 11:22:28 +0200 Subject: rewrite parts of docs/Contribute --- docs/Contribute.md | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/Contribute.md b/docs/Contribute.md index b5fb80ff..c30d9925 100644 --- a/docs/Contribute.md +++ b/docs/Contribute.md @@ -1,36 +1,31 @@ # Contributing -*Thank you for considering contributing to **Hyprland**.* +*Thank you for considering contributing to Hyprland.*
## Development -Check the **[Wiki]** for debugging instructions. +Check the [Wiki] for debugging instructions. -Afterwards, pick yourself an **[Issue]**
-or *implement your own suggestion!* +Afterwards, pick yourself an [Issue] or implement your own suggestion. -*As the **Hyprland** is still in its early stages,*
-*I'd recommend you stick to bug fixes first.* +*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*** +- Please follow the code style -- Code must be ***readable*** +- Code must be readable -- **Features** should be ***useful*** +- Features should be useful -- **Bugfixes** should ***works*** +- Test your changes! -- ***Test your changes!*** - - *Run it on bare metal and*
- *check if everything works.* + *Run it on bare metal and check if everything works.* -- cgit v1.2.3 From da59b932749319b96380c5cb212ed20e1db0cbdc Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Tue, 19 Apr 2022 11:26:34 +0200 Subject: cleanup --- docs/Contribute.md | 4 ---- docs/Install.md | 12 ------------ 2 files changed, 16 deletions(-) (limited to 'docs') diff --git a/docs/Contribute.md b/docs/Contribute.md index c30d9925..c921ce40 100644 --- a/docs/Contribute.md +++ b/docs/Contribute.md @@ -3,8 +3,6 @@ *Thank you for considering contributing to Hyprland.* -
- ## Development Check the [Wiki] for debugging instructions. @@ -13,8 +11,6 @@ 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 diff --git a/docs/Install.md b/docs/Install.md index 592a27f7..2b8c3a7e 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -1,39 +1,27 @@ # 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.***
*If they don't work, try building manually.* -
- #### Arch ( AUR / -git ) ```sh yay -S hyprland-git ``` -
--- -
## Building -- cgit v1.2.3