https://github.com/puria/lua-starter-template
🌚 Lua project starter, with Github Actions, busted unit testing, luacheck linting, luacov coverage and reuse license validation
https://github.com/puria/lua-starter-template
Last synced: 3 months ago
JSON representation
🌚 Lua project starter, with Github Actions, busted unit testing, luacheck linting, luacov coverage and reuse license validation
- Host: GitHub
- URL: https://github.com/puria/lua-starter-template
- Owner: puria
- Created: 2022-01-28T16:19:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T13:48:05.000Z (9 months ago)
- Last Synced: 2025-01-22T11:47:43.802Z (5 months ago)
- Language: Makefile
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSES/AGPL-3.0-or-later.txt
Awesome Lists containing this project
README
{project_name}
{tagline}
💾 Install
•
🎮 Quick start
•
🐋 Docker
•
🐝 API
•
🔧 Configuration
•
📋 Testing
•
🐛 Troubleshooting & debugging
•
😍 Acknowledgements
•
🌐 Links
•
👤 Contributing
•
💼 License
Abstract description like: 🚧 Zenroom is a software in **ALPHA stage** and are part of the [DECODE project](https://decodeproject.eu) about data-ownership and [technological sovereignty](https://www.youtube.com/watch?v=RvBRbwBm_nQ). Our effort is that of improving people's awareness of how their data is processed by algorithms, as well facilitate the work of developers to create along [privacy by design principles](https://decodeproject.eu/publications/privacy-design-strategies-decode-architecture) using algorithms that can be deployed in any situation without any change.
🚩 Table of Contents (click to expand)
* [Install](#-install)
* [Quick start](#-quick-start)
* [Docker](#-docker)
* [API](#-api)
* [Configuration](#-configuration)
* [Testing](#-testing)
* [Troubleshooting & debugging](#-troubleshooting--debugging)
* [Acknowledgements](#-acknowledgements)
* [Links](#-links)
* [Contributing](#-contributing)
* [License](#-license)
***
## 💾 Install
```pip install / yard add {project_name}```
***
## 🎮 Quick start
To start using {project_name} just (fill with real documentation)
***
## 🐋 Docker
```bash
docker build -t {project_name} .
docker run --rm -it {project_name}
```
**[🔝 back to top](#toc)**
***
## 🐝 API
**[🔝 back to top](#toc)**
***
## 🔧 Configuration
**[🔝 back to top](#toc)**
***
## 📋 Testing
**[🔝 back to top](#toc)**
***
## 🐛 Troubleshooting & debugging
**[🔝 back to top](#toc)**
***
## 😍 Acknowledgements
[](http://www.dyne.org)
Copyleft (ɔ) 2021 by [Dyne.org](https://www.dyne.org) foundation, Amsterdam
Designed, written and maintained by Puria Nafisi Azizi.
Special thanks to Mr. W. White for his special contributions.
**[🔝 back to top](#toc)**
***
## 🌐 Links
https://www.somelink.io/
https://dyne.org/
**[🔝 back to top](#toc)**
***
## 👤 Contributing
Please first take a look at the [Dyne.org - Contributor License Agreement](CONTRIBUTING.md) then
1. 🔀 [FORK IT](../../fork)
2. Create your feature branch `git checkout -b feature/branch`
3. Commit your changes `git commit -am 'Add some fooBar'`
4. Push to the branch `git push origin feature/branch`
5. Create a new Pull Request
6. 🙏 Thank you
**[🔝 back to top](#toc)**
***
## 💼 License
{project_name} - {tagline}
Copyleft (ɔ) 2021 Dyne.org foundation, Amsterdam
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
**[🔝 back to top](#toc)**