Skip to content

Commit

Permalink
Enhance readme
Browse files Browse the repository at this point in the history
- Restructuring installation and uninstallation section
- adding vim demo video
  • Loading branch information
proffapt committed Nov 28, 2022
1 parent cd01b38 commit be22ebe
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
<h3 align="center">code-runner</h3>

<p align="center">
<i>run supported lang files with single command</i>
<i>execute code files with ease</i>
<br />
<a href="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/proffapt/code-runner"><strong>Explore the docs »</strong></a>
<a href="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/proffapt/code-runner#readme"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/proffapt/code-runner/issues">Report Bug</a>
Expand All @@ -41,6 +41,9 @@
<ul>
<li><a href="#installation">Installation</a></li>
</ul>
<ul>
<li><a href="#uninstallation">Uninstallation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#integrating-with-vscode">Integrating with vscode</a></li>
Expand All @@ -54,15 +57,15 @@
<!-- ABOUT THE PROJECT -->
## About The Project

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

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

### Built With

This project is made with following langs/frameworks.

* BASH
* [Bash](https://devdocs.io/bash/)

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

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

### Installation

_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._
_To install and configure the project on your system locally:_

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

```sh
curl https://raw.githubusercontent.com/proffapt/code-runner/main/setup.sh | /bin/bash
curl https://raw.githubusercontent.com/proffapt/code-runner/main/setup.sh | bash
```
2. Run the code
```sh
Expand All @@ -87,10 +90,13 @@ _Now since we are done with the setting up of environment suitable for the proje
```sh
run ~/path/to/my_code.c
```

### Uninstallation

_To uninstall the tool from your system execute the following command_

3. Uninstall using the following command
```sh
curl https://raw.githubusercontent.com/proffapt/code-runner/main/uninstall.sh | /bin/bash
curl https://raw.githubusercontent.com/proffapt/code-runner/main/uninstall.sh | bash
```

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

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

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

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

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


<!-- MARKDOWN LINKS & IMAGES -->

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

0 comments on commit be22ebe

Please sign in to comment.