Skip to content

Commit 94f61f7

Browse files
updated readme for 3.0.0
1 parent 669d877 commit 94f61f7

File tree

2 files changed

+62
-21
lines changed

2 files changed

+62
-21
lines changed

.github/img/aurpromo.png

42 KB
Loading

README.md

Lines changed: 62 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44

5-
![image](https://github.com/user-attachments/assets/f717ccc0-c2b5-43b6-b8c9-bb305e4dcfbb)
5+
<img src="quickoflow.png" height="100" width="auto" align-content="center">
66

77

88
![C](https://img.shields.io/badge/c-%2300599C.svg?style=for-the-badge&logo=c&logoColor=white)
@@ -15,6 +15,14 @@
1515
> [!WARNING]
1616
> 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.
1717
18+
<br>
19+
<a href="https://aur.archlinux.org/packages/quickoverflow">
20+
<img src=".github/img/aurpromo.png" height="100" >
21+
</img>
22+
</a>
23+
24+
<br>
25+
1826
A Command Line Tool for Unix Based Operating Systems to instantly open Stack Overflow Solution for corresponding error
1927

2028
Tired of googling all the time by copy pasting errors and getting incorrect solutions from LLMs?
@@ -23,7 +31,7 @@ QuickOverflow has a solution for that.
2331

2432
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.
2533

26-
As of v2.1.0, QuickOverflow only supports Python debugging. However, support for other languages is planned and underway.
34+
As of v3.0.1, QuickOverflow only supports Python debugging. However, support for other languages is planned and underway.
2735

2836
## Getting Started
2937

@@ -34,32 +42,33 @@ To get started you must have:
3442

3543
Most distributions come with Python3 installed, however Python 3.12 is highly recommended for dependency compatibility
3644

37-
Check your python version using
3845

39-
```sh
40-
$ python3 --version
41-
```
42-
If you have a different version, follow the steps below:
46+
## Installation
47+
48+
QuickOverflow is now available on AUR for Arch Linux Users!
49+
50+
QuickOverflow on Arch Linux requires `yay` to be installed.
4351

44-
For Ubuntu/Debian Based Distros
52+
Install `yay` using the following command
4553

4654
```sh
47-
$ sudo apt install python3.12
55+
$ sudo pacman -S yay
4856
```
4957

50-
For Fedora/CentOS/RedHat Based Distros
58+
- Install QuickOverflow from AUR using `yay`
5159

5260
```sh
53-
$ sudo dnf install python3.12
61+
$ sudo yay -S quickoverflow
5462
```
5563

56-
For Arch Linux Based Distros
64+
- Start QuickOverflow by typing
5765

5866
```sh
59-
$ sudo pacman -S python312
67+
$ QuickOverflow
6068
```
6169

62-
## Installation
70+
71+
For Non Arch Linux Users/Building from source:
6372

6473
- Clone the repository
6574

@@ -79,16 +88,12 @@ $ cd QuickOverflow
7988
$ make
8089
```
8190

82-
- Run the run script to start using QuickOverflow
91+
- Run the command to start using QuickOverflow
8392

8493
```sh
85-
$ sh run.sh
94+
$ QuickOverflow
8695
```
87-
- To uninstall QuickOverflow
8896

89-
```sh
90-
$ make uninstall
91-
```
9297

9398
## User Manual
9499

@@ -112,4 +117,40 @@ Type `help` to get a list of supported commands
112117

113118
Type `search` to start searching for errors from your code
114119

115-
120+
## Maintainer
121+
122+
<table>
123+
<thead>
124+
<tr>
125+
<th>Name</th>
126+
<th>Role</th>
127+
</tr>
128+
</thead>
129+
<tbody>
130+
<tr>
131+
<td><a href="https://github.com/spaciouscoder78" > Aryan Karamtoth</td>
132+
<td>Author</td>
133+
</tr>
134+
<tr>
135+
<td><a href="https://github.com/lonelyguy123">Shastha Tyarla</td>
136+
<td>Maintainer</td>
137+
</tr>
138+
</tbody>
139+
</table>
140+
141+
## Credits
142+
143+
<table>
144+
<thead>
145+
<tr>
146+
<th>Name</th>
147+
<th>Contribution</th>
148+
</tr>
149+
</thead>
150+
<tbody>
151+
<tr>
152+
<td><a href="https://github.com/honeypallakonda" > Honey Pallakonda</td>
153+
<td>App Icon</td>
154+
</tr>
155+
</tbody>
156+
</table>

0 commit comments

Comments
 (0)