https://github.com/lua-rocks/lua-template

https://github.com/lua-rocks/lua-template

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/lua-rocks/lua-template
• Owner: lua-rocks
• License: mit
• Archived: true
• Created: 2022-01-01T15:34:52.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-30T03:39:04.000Z (almost 3 years ago)
• Last Synced: 2024-08-06T18:26:46.894Z (5 months ago)
• Language: Lua
• Size: 52.7 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • License: license.md

Awesome Lists containing this project

README

        
# Lua template

This template is designed for any lua-based projects and using [emmylua][]

format compatible with [sumneko-language-server][].

## Pre-requirements

- lua >5 or luajit >2

- luarocks >3

## Installation

- Fork this repo

- Clone your fork

- Install dependencies: `lua run/install.lua`

- Update submodules: `lua run/update.lua`

- Run helloworld: `lua run/default.lua`

## Content

### Libraries

- **[inspect][]** - variable inspector

- **[lume][]** - collection of first-needed functions

- **[proto][]** - oop library

- **[log][]** - simple logger

[inspect]: https://github.com/kikito/inspect.lua

[lume]: https://github.com/rxi/lume

[proto]: https://github.com/lua-rocks/proto

[log]: https://github.com/rxi/log.lua

[emmylua]: https://git.io/JST0j

[sumneko-language-server]: https://is.gd/JiUVQe