Skip to content

Commit 7661e6b

Browse files
feat: adjusted docs and scripts to install on multiple distros
1 parent 4fd279a commit 7661e6b

File tree

4 files changed

+38
-17
lines changed

4 files changed

+38
-17
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,48 @@
66

77
A Command Line Tool for Unix Based Operating Systems to instantly open Stack Overflow Solution for corresponding error
88

9-
Currently only on Ubuntu/Debian Based Systems
10-
119
Tired of googling all the time by copy pasting errors and getting incorrect solutions from LLMs?
1210

1311
QuickOverflow has a solution for that.
1412

15-
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.
13+
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.
1614

17-
As of v1.0, QuickOverflow only supports Python debugging. However, support for other language and distributions is planned and underway.
15+
As of v1.0, QuickOverflow only supports Python debugging. However, support for other languages is planned and underway.
1816

1917
## Getting Started
2018

2119
To get started you must have:
2220

23-
- A supported Ubuntu/Debian System
21+
- Linux Based Operating System
2422
- Python 3.12
2523

24+
Most distributions come with Python3 installed, however Python 3.12 is highly recommended for dependency compatibility
25+
26+
Check your python version using
27+
28+
```sh
29+
$ python3 --version
30+
```
31+
If you have a different version, follow the steps below:
32+
33+
For Ubuntu/Debian Based Distros
34+
35+
```sh
36+
$ sudo apt install python3.12
37+
```
38+
39+
For Fedora/CentOS/RedHat Based Distros
40+
41+
```sh
42+
$ sudo dnf install python3.12
43+
```
44+
45+
For Arch Linux Based Distros
46+
47+
```sh
48+
$ sudo pacman -S python312
49+
```
50+
2651
## Installation
2752

2853
- Clone the repository
@@ -31,16 +56,16 @@ To get started you must have:
3156
$ git clone https://github.com/SpaciousCoder78/QuickOverflow.git
3257
```
3358

34-
- Run the install script on your Ubuntu/Debian System
59+
- Run the install script on your Linux system
3560

3661
```sh
37-
sudo sh install.sh
62+
$ sh install.sh
3863
```
3964

4065
- Run the run script to start using QuickOverflow
4166

4267
```sh
43-
sh run.sh
68+
$ sh run.sh
4469
```
4570

4671
## User Manual

headers/shellops.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
*
55
* @author Aryan Karamtoth (SpaciousCoder78)
66
*
7-
* @date Thursday, August 15 2024
7+
* @date Saturday, June 07 2025
88
*
9-
* @brief Gigahertz Shell's Operation Functions
9+
* @brief QuickOverflow's Operation Functions
1010
*
1111
*
1212
*

install.sh

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
#!/usr/bin/env bash
22

3-
#Run on Debian/Ubuntu Based Systems
4-
5-
sudo apt install python3.12
6-
73
pip3 install -r requirements.txt --break-system-packages
84

95
mkdir -p bin

main.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
*
77
* @author Aryan Karamtoth(SpaciousCoder78)
88
*
9-
* @date Thursday, August 15 2024
9+
* @date Thursday, June 07 2025
1010
*
11-
* @brief Gigahertz Shell
11+
* @brief QuickOverflow
1212
*
13-
* @details Main file of Gigahertz Shell
13+
* @details Main file of QuickOverflow
1414
*
1515
*
1616
*

0 commit comments

Comments
 (0)