Installing the Project

Just like any open-source software, we are open to contributors and would love to have some extra helping hands! This section will go over how to correctly install the Lua++ project so that you can become a contributor.

Step 1: Forking the Repository

The first and most important part of this process is forking your desired repository. There are a few steps to this process:

1. On GitHub.com, navigate to the luapp-org/luapp repository.

2. In the top right corner of the page, click Fork.

   

   The Fork button at the top right of the page

3. Once you have forked the repository, you need to clone the repo to your local machine so that you can add your changes. You can find the link to the repo after clicking the Code dropdown.

   

   The Clone menu for the repo.

   Then run the clone command in your local environment: git clone <link>

Before you can get to contributing you need to install Lua++'s few dependencies. Instructions are listed below in the order of your operating system.

Linux

You need to install make, flex, and bison. To install them on a Linux machine run the following commands:

sudo apt update
sudo apt install flex
sudo apt install bison
sudo apt install make

Then you need to enter the main source folder and build the desired project (e.g. make interpreter). The binaries are stored in src/bin with luappc being the compiler, luappvm the VM, and luapp the interpreter.

Step 2: Creating a Pull Request

1. To begin committing new changes to your fork, you need to first create a new branch. This can be done with the following command: git checkout -b new-user-contribution

1. Once you have committed your changes to your new branch, you need to create a pull request.

   

   How to create a new pull request.

Thank you for showing interest Lua++, we hope that we can get as much assistance from the community as possible. Happy coding!