Table of Contents
This repository is a template for a project using the Lua programming language. It contains a hello world program, readme, license and other files that you would want in any project.
To get started with this project, decide where you will place your local repository and follow these simple steps.
You need to have a working git installation and a Lua interpreter.
You could also need a Lua compiler if you want to compile your project. I recommend LuaJIT
- Clone this repository
git clone https://gitlab.com/ragagno/neutronium-lua.git
- Rename the directory
- Edit the files
README.md,CHANGELOG.md,LICENSE... - Start working on your project
I recommend that you develop your project in a JetBrains IDE with a plugin that add Lua support, or in a basic text editors like JetBrains Fleet or Visual Studio Code.
You can execute your program with the following command.
lua sources/main.luaSee the open issues for a list of feature requests and known problems.
Contributions are the backbone of the open source community and are greatly appreciated. You can contribute in several manners.
The first one is to propose a pull request to the project for improving its features directly.
The second one is to open an issue when you encounter a bug or have a feature request.
The third one is to financially support the development of the project. If you feel like it, you can buy me a coffee on Ko-Fi.
Copyright (c) 2023-present Ragagno
Distributed under the MIT License. See LICENSE.txt for more information.
Note that this project is not actually under any license, and this part serves only as a placeholder for your license.
I recommend the MIT License or the GNU AGPL. If you want more choices, GitHub made a website that compares common licenses.
Ragagno - @ragocraft - ragocraft@gmail.com
Project Link: https://gitlab.com/ragagno/neutronium-lua
This project would not have been possible without Markdown and JetBrains Fleet.
A special thanks to the contributor of the project: