Add GTK Installation Guide to Documentation (#99)

* Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update INSTALLATION.md * Update index.md
harilvfs · Nov 20, 2024 · 5efe137 · 5efe137
1 parent bbb8355
commit 5efe137
Show file tree

Hide file tree

Showing 2 changed files with 86 additions and 0 deletions.
diff --git a/.github/INSTALLATION.md b/.github/INSTALLATION.md
@@ -26,6 +26,49 @@ carch
 > [!Tip]
 > You don't need to run the installation script every time. You can run it once, and then simply type carch in your terminal whenever you want to automatically execute the Carch script.
 
+## GTK
+**The GTK version of Carch is available.**
+
+> [!CAUTION]
+> The GTK version of Carch is currently under development. <br>
+> It’s not fully ready for use and needs some script updates to work properly. You may try it now as you would with the usual Carch script.
+
+**How to Install and Use 📦**
+
+<img src="https://github.com/harilvfs/assets/blob/main/carch/arrowdown.png" width="20" />
+
+### Prerequisites
+
+Before you start, you'll need to install `Python` dependencies.
+
+On Arch Linux:
+
+```bash
+sudo pacman -S python
+```
+
+Using AUR (with `paru` or `yay`):
+
+```bash
+paru -S python
+# or
+yay -S python
+```
+
+### Install and Run Carch
+
+Clone the Carch repository and run the GTK script:
+
+```bash
+git clone https://github.com/harilvfs/carch
+cd carch
+python3 carch-gtk.py
+```
+
+> [!NOTE]
+> If any errors pop up while running the script, they are likely related to missing dependencies. Make sure to install all required Python dependencies.
+
+
 ## Aur
 [![Packaging status](https://repology.org/badge/vertical-allrepos/carch.svg)](https://repology.org/project/carch/versions)
 

diff --git a/docs/index.md b/docs/index.md
@@ -12,6 +12,7 @@
 - [Features](#features)
 - [Installation](#installation)
 - [Usage](#usage)
+- [GTK](#gtk)
 - [Aur](#aur)
 - [Script Overview](#scripts)
 - [Roadmap](#roadmap)
@@ -68,6 +69,48 @@ carch
 > [!Tip]
 > You don't need to run the installation script every time. You can run it once, and then simply type carch in your terminal whenever you want to automatically execute the Carch script.
 
+## GTK
+**The GTK version of Carch is available.**
+
+> [!CAUTION]
+> The GTK version of Carch is currently under development. <br>
+> It’s not fully ready for use and needs some script updates to work properly. You may try it now as you would with the usual Carch script.
+
+**How to Install and Use 📦**
+
+<img src="https://github.com/harilvfs/assets/blob/main/carch/arrowdown.png" width="20" />
+
+### Prerequisites
+
+Before you start, you'll need to install `Python` dependencies.
+
+On Arch Linux:
+
+```bash
+sudo pacman -S python
+```
+
+Using AUR (with `paru` or `yay`):
+
+```bash
+paru -S python
+# or
+yay -S python
+```
+
+### Install and Run Carch
+
+Clone the Carch repository and run the GTK script:
+
+```bash
+git clone https://github.com/harilvfs/carch
+cd carch
+python3 carch-gtk.py
+```
+
+> [!NOTE]
+> If any errors pop up while running the script, they are likely related to missing dependencies. Make sure to install all required Python dependencies.
+
 ## Aur
 [![Packaging status](https://repology.org/badge/vertical-allrepos/carch.svg)](https://repology.org/project/carch/versions)