Merge pull request #35 from SpaciousCoder78/development

feat: added desktop icon for ubuntu && updated documentation

Author: SpaciousCoder78

.github/img/aurpromo.png

@@ -2,6 +2,7 @@
 #Update 2.1.0 - Added make to replace install.sh
 #type make into terminal to install QuickOverflow
 ubuntu: main.c
+	sudo apt install gnome-terminal
 	sudo apt install pip
 	sudo apt install pipenv
 	pipenv install --python python3
@@ -11,6 +12,8 @@ ubuntu: main.c
 	chmod +x search.py
 	pipenv run pyinstaller --onefile --name search search.py
 	sudo mv "dist/search" "/usr/local/bin"
+	sudo mv "quickoflow.png" "/usr/share/icons/Humanity/apps/32"
+	sudo mv "quickoverflow.desktop" "/home/$$USER/.local/share/applications"
 
 arch_linux: main.c
 	sudo pacman -S gcc

Makefile

@@ -1,8 +1,11 @@
 # QuickOverflow
 
 
+<p align="center">
+  <img src="quickoflow.png" height="100" width="auto" align-content="center">
+</p>
+
 
-![image](https://github.com/user-attachments/assets/f717ccc0-c2b5-43b6-b8c9-bb305e4dcfbb)
 
 
 ![C](https://img.shields.io/badge/c-%2300599C.svg?style=for-the-badge&logo=c&logoColor=white)
@@ -15,6 +18,14 @@
 > [!WARNING]
 > AI generated issues and PRs will be denied. I don't want QuickOverflow to be vibe developed. Feel free to use LLMs to fix bugs or critical errors but rest of the code needs to be human written.
 
+<br>
+<a href="https://aur.archlinux.org/packages/quickoverflow"> 
+    <img src=".github/img/aurpromo.png" height="100" > 
+    </img> 
+</a>
+
+<br>
+
 A Command Line Tool for Unix Based Operating Systems to instantly open Stack Overflow Solution for corresponding error
 
 Tired of googling all the time by copy pasting errors and getting incorrect solutions from LLMs?
@@ -23,7 +34,7 @@ QuickOverflow has a solution for that.
 
 QuickOverflow is a Command Line Tool for Linux based systems to quickly get to solutions for your errors on browser right from your terminal, without ever clicking on your browser icon.
 
-As of v2.1.0, QuickOverflow only supports Python debugging. However, support for other languages is planned and underway.
+As of v3.0.1, QuickOverflow only supports Python debugging. However, support for other languages is planned and underway.
 
 ## Getting Started
 
@@ -32,13 +43,40 @@ To get started you must have:
 - Linux Based Operating System
 - Python 3
 
-
 ## Contributing
 
 For contribution guide and guidelines, check ![CONTRIBUTING.md](https://github.com/SpaciousCoder78/QuickOverflow/blob/main/CONTRIBUTING.md)
 
+
+
 ## Installation
 
+QuickOverflow is now available on AUR for Arch Linux Users!
+
+QuickOverflow on Arch Linux requires `yay` to be installed.
+
+Install `yay` using the following command
+
+```sh
+$ sudo pacman -S yay
+```
+
+- Install QuickOverflow from AUR using `yay`
+
+```sh
+$ sudo yay -S quickoverflow
+```
+
+- Start QuickOverflow by typing
+
+```sh
+$ QuickOverflow
+```
+
+
+
+For Non Arch Linux Users/Building from source:
+
 This software uses Make for build system, ensure you have Make installed
 
 - Clone the repository
@@ -58,6 +96,7 @@ $ cd QuickOverflow
 ```sh
 $ make ubuntu
 ```
+
 - For Arch Linux Based Distributions, run
 
 ```sh
@@ -70,6 +109,7 @@ $ make arch_linux
 $ QuickOverflow
 ```
 
+
 ## User Manual
 
 Got stuck? Not sure how to use the software? This guide is for you
@@ -78,13 +118,13 @@ Supported Programming Languages:
 
 - Python
 
-Run the `run.sh` file post installation to use the software.
+Type `QuickOverflow` into your terminal.
 
 You will see this once you run it
 
 ```sh
 
-$ sh run.sh
+$ QuickOverflow
 QuickOverflow >
 
 ```
@@ -94,3 +134,45 @@ Type `search` to start searching for errors from your code
 
 For a more in-depth guide, check <a href="https://github.com/SpaciousCoder78/QuickOverflow/wiki/User-Manual"> User Manual Wiki </a>
 
+
+## Maintainer
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Role</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><a href="https://github.com/spaciouscoder78" > Aryan Karamtoth</td>
+            <td>Author</td>
+        </tr>
+        <tr>
+            <td><a href="https://github.com/lonelyguy123">Shastha Tyarla</td>
+            <td>Maintainer</td>
+        </tr>
+    </tbody>
+</table>
+
+## Credits
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Contribution</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><a href="https://github.com/honeypallakonda" > Honey Pallakonda</td>
+            <td>App Icon</td>
+        </tr>
+    </tbody>
+</table>
+
+
+
+

README.md

@@ -95,7 +95,7 @@ int quickoverflow_help(char **args){
 "\\ \\/' / |_| | | (__|   <\\ \\_/ /\\ V /  __/ |  | | | | (_) \\ V  V / \n"
 " \\_/\\_\\\\__,_|_|\\___|_|\\_\\\\___/  \\_/ \\___|_|  |_| |_|\\___/ \\_/\\_  \n"
 "                        \n");
-  printf("---------------------------------Version 3.0.0----------------------------\n");
+  printf("---------------------------------Version 3.0.1----------------------------\n");
   printf("Type program names and arguments, and hit enter.\n");
   printf("The following are built in:\n");
 
@@ -123,11 +123,10 @@ int quickoverflow_about(char **args){
 "\\ \\/' / |_| | | (__|   <\\ \\_/ /\\ V /  __/ |  | | | | (_) \\ V  V / \n"
 " \\_/\\_\\\\__,_|_|\\___|_|\\_\\\\___/  \\_/ \\___|_|  |_| |_|\\___/ \\_/\\_  \n"
 "                                                                                                                               \n");
-    printf("Version:  3.0.0\n");
+    printf("Version:  3.0.1\n");
     printf("License: GNU GPL-3 License\n");
     printf("Author: Aryan Karamtoth (SpaciousCoder78)\n");
     printf("Author Email: aryankmmiv@outlook.com\n");
-    printf("Supported Operating Systems: Linux\n");
     printf("Github Repository: https://github.com/SpaciousCoder78/QuickOverflow\n");
     printf("Github Issues: https://github.com/SpaciousCoder78/QuickOverflow/issues\n");
 }

headers/commands.h

@@ -0,0 +1,10 @@
+[Desktop Entry]
+Version=1.0
+Name=QuickOverflow
+Comment=A CLI Tool to auto-detect code errors and open solutions.
+Exec=gnome-terminal -- /usr/local/bin/QuickOverflow
+Path=/home
+Icon=/usr/share/icons/Humanity/apps/32/quickoflow.png
+Terminal=True
+Type=Application
+Categories=Utility;Development;