v1.0 - final commit

Author: SpaciousCoder78

.gitignore

@@ -1,5 +1,2 @@
-pyoverflow-cli
-a.out
-pyoverflow.tar.gz
-~
-quickoverflow
+
+bin

README.md

@@ -1,18 +1,68 @@
 # QuickOverflow
+![C](https://img.shields.io/badge/c-%2300599C.svg?style=for-the-badge&logo=c&logoColor=white)
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+![Bash Script](https://img.shields.io/badge/bash_script-%23121011.svg?style=for-the-badge&logo=gnu-bash&logoColor=white)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+
 A Command Line Tool for Unix Based Operating Systems to instantly open Stack Overflow Solution for corresponding error
 
+Currently only on Ubuntu/Debian Based Systems
+
+Tired of googling all the time by copy pasting errors and getting incorrect solutions from LLMs?
+
+QuickOverflow has a solution for that.
+
+QuickOverflow is a Command Line Tool for Ubuntu/Debian 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 v1.0, QuickOverflow only supports Python debugging. However, support for other language and distributions is planned and underway.
+
+## Getting Started
+
+To get started you must have:
+
+- A supported Ubuntu/Debian System
+- Python 3.12
+
+## Installation
+
+- Clone the repository 
+
+```sh
+$ git clone https://github.com/SpaciousCoder78/QuickOverflow.git
+```
+
+- Run the install script on your Ubuntu/Debian System
+
+```sh
+  sudo sh install.sh
+```
+
+- Run the run script to start using QuickOverflow
+
+```sh
+  sh run.sh
+```
+
+## User Manual
+
+Got stuck? Not sure how to use the software? This guide is for you
+
+Supported Programming Languages:
+
+- Python
+
+Run the `run.sh` file post installation to use the software.
+
+You will see this once you run it
+
+```sh
+
+$ sh run.sh
+QuickOverflow >
 
+```
+Type `help` to get a list of supported commands
 
-gcc -Wall -I/usr/include/python3.12  main.c -lpython3.12 -o pyoverflow-cli
+Type `search` to start searching for errors from your code
 
-#Install Pyenv
-git clone https://github.com/pyenv/pyenv.git ~/.pyenv
-git clone https://github.com/pyenv/pyenv-virtualenv.git $(pyenv root)/plugins/pyenv-virtualenv
-export PATH=~/.pyenv/bin:/usr/local/hadoop/bin/:$PATH
-echo 'export PYENV_ROOT="~/.pyenv"' >> ~/.bash_profile
-echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bash_profile
-echo 'eval "$(pyenv init -)"' >> ~/.bash_profile
 
-#Install Python
-pyenv install 2.7.18
-pyenv virtualenv 2.7.18 pyoverflow

install.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+#Run on Debian/Ubuntu Based Systems
+
+sudo apt install python3.12
+
+pip3 install -r requirements.txt --break-system-packages
+
+mkdir -p bin
+gcc -I/usr/include/python3.12  main.c -lpython3.12 -o bin/QuickOverflow
+
+
+
+

run.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+./bin/QuickOverflow

search.py

@@ -1,18 +1,10 @@
 #!/usr/bin/env python
 
 from pyoverflow3.pyoverflow3 import pyoverflow3
+
+error = input("Input the Python error here: ")
 
-a = input("Enter first number")
- 
-b = input("Enter second number")
- 
- 
-try:
-    div = a/b
-    print(div)
- 
-except Exception as e:
-    #Error message and number of solutions
-    pyoverflow3.submit_error(str(e),2)
+
+pyoverflow3.submit_error(str(error),2)
 
 #Wait for the magic :)