Skip to content

Commit be22ebe

Browse files
authored
Enhance readme
- Restructuring installation and uninstallation section - adding vim demo video
1 parent cd01b38 commit be22ebe

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
<h3 align="center">code-runner</h3>
1515

1616
<p align="center">
17-
<i>run supported lang files with single command</i>
17+
<i>execute code files with ease</i>
1818
<br />
19-
<a href="https://github.com/proffapt/code-runner"><strong>Explore the docs »</strong></a>
19+
<a href="https://github.com/proffapt/code-runner#readme"><strong>Explore the docs »</strong></a>
2020
<br />
2121
<br />
2222
<a href="https://github.com/proffapt/code-runner/issues">Report Bug</a>
@@ -41,6 +41,9 @@
4141
<ul>
4242
<li><a href="#installation">Installation</a></li>
4343
</ul>
44+
<ul>
45+
<li><a href="#uninstallation">Uninstallation</a></li>
46+
</ul>
4447
</li>
4548
<li><a href="#usage">Usage</a></li>
4649
<li><a href="#integrating-with-vscode">Integrating with vscode</a></li>
@@ -54,15 +57,15 @@
5457
<!-- ABOUT THE PROJECT -->
5558
## About The Project
5659

57-
This is a script written in bash, which compiles the code file and run it for you and delete other junk files if created during the process of compilation, all this with one command.
60+
This is a script, which compiles the code file and run it for you and delete other _junk_ files if created during the process of compilation, all this with one command for all the languages supported by it. No more remembering different arguments for different compilers to compile, execut and debug the code.
5861

5962
<p align="right">(<a href="#top">back to top</a>)</p>
6063

6164
### Built With
6265

6366
This project is made with following langs/frameworks.
6467

65-
* BASH
68+
* [Bash](https://devdocs.io/bash/)
6669

6770
<p align="right">(<a href="#top">back to top</a>)</p>
6871

@@ -72,12 +75,12 @@ This project is made with following langs/frameworks.
7275

7376
### Installation
7477

75-
_Now since we are done with the setting up of environment suitable for the project to compile/run, let's install and configure the project on your system locally now._
78+
_To install and configure the project on your system locally:_
7679

7780
1. Copy and run the following command to install the run binary on your system.
7881

7982
```sh
80-
curl https://raw.githubusercontent.com/proffapt/code-runner/main/setup.sh | /bin/bash
83+
curl https://raw.githubusercontent.com/proffapt/code-runner/main/setup.sh | bash
8184
```
8285
2. Run the code
8386
```sh
@@ -87,10 +90,13 @@ _Now since we are done with the setting up of environment suitable for the proje
8790
```sh
8891
run ~/path/to/my_code.c
8992
```
93+
94+
### Uninstallation
95+
96+
_To uninstall the tool from your system execute the following command_
9097

91-
3. Uninstall using the following command
9298
```sh
93-
curl https://raw.githubusercontent.com/proffapt/code-runner/main/uninstall.sh | /bin/bash
99+
curl https://raw.githubusercontent.com/proffapt/code-runner/main/uninstall.sh | bash
94100
```
95101

96102
<p align="right">(<a href="#top">back to top</a>)</p>
@@ -150,6 +156,7 @@ I made a custom keybinding to work with my code-runner on vim, add the lines fro
150156

151157
>> _Stores previous execution history, as there is no new buffer created everytime, it's created only when not present else uses the same buffer_
152158
159+
https://user-images.githubusercontent.com/86282911/204343876-fa160388-ba4c-47be-88a0-16c6f7e7c1cb.mp4
153160

154161
<p align="right">(<a href="#top">back to top</a>)</p>
155162

@@ -199,7 +206,6 @@ Do consider looking at other paradigms of this documentation
199206

200207
<p align="right">(<a href="#top">back to top</a>)</p>
201208

202-
203209
<!-- MARKDOWN LINKS & IMAGES -->
204210

205211
[contributors-shield]: https://img.shields.io/github/contributors/proffapt/code-runner.svg?style=for-the-badge

0 commit comments

Comments
 (0)