code-runner

run supported lang files with single command
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Change.log
7. License
8. Contact
9. Acknowledgments

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.

(back to top)

Built With

This project is made with following langs/frameworks.

• BASH

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You will need to install the following dependencies for the project to work.

• gcc

  sudo apt install -y gcc // DEBIAN based
  brew install gcc // MACos
  sudo pacman -Sy gcc // Arch

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.

1. Clone the repo

   git clone https://github.com/proffapt/code-runner.git

2. Make the script executable

   cd ./code-runner
   chmod +x ./crunner

3. Add the alias to you shell config file

   echo "alias run="path/to/crunner"" >> ~/.SHELL_CONFIG
   source ~/.SHELL_CONFIG

(back to top)

Usage

(back to top)

Roadmap

• Add the Documentation other then README.md
• Add crunner
• Add support for c and cpp files
• Add the main documentation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Changelog

v1.0.0

Added or Changed

• Added this changelog :)
• Added support for C and C++ files.
• Added help menu

Removed

• Removed the -f flag

License

Distributed under the BSD-2-Clause License. See LICENSE.txt for more information.

(back to top)

Contact

Arpit Bhardwaj - Twitter - Telegram - [email protected]

Company website: Cybernity - CybernityForum

Project Link: https://github.com/proffapt/code-runner

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to.

• Choose an Open Source License
• Img Shields
• Bash filename manipulation

(back to top)