tooling/bins/darklua/README.md

41 lines
No EOL
1.5 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[![checks](https://github.com/seaofvoices/daklua/actions/workflows/test.yml/badge.svg)](https://github.com/seaofvoices/darklua/actions/workflows/test.yml)
[![site](https://github.com/seaofvoices/darklua/actions/workflows/site.yml/badge.svg)](https://darklua.com/)
[![version](https://img.shields.io/crates/v/darklua)](https://crates.io/crates/darklua)
[![license](https://img.shields.io/crates/l/darklua)](LICENSE.txt)
[![GitHub all releases](https://img.shields.io/github/downloads/seaofvoices/darklua/total)](https://github.com/seaofvoices/darklua/releases)
[![GitHub top language](https://img.shields.io/github/languages/top/seaofvoices/darklua)](https://www.rust-lang.org/)
# darklua
Transform Lua 5.1 and Roblox Lua scripts using rules.
# [Documentation](https://darklua.com/docs)
Visit https://darklua.com/docs to learn how to use darklua.
# [Try It!](https://darklua.com/try-it)
You can try darklua directly into your browser! Check out https://darklua.com/try-it.
# [Installation](https://darklua.com/docs/installation/)
## [Foreman](https://github.com/Roblox/foreman)
If you are already using Foreman, then installing darklua is as simple as adding this line in the foreman.toml file:
```toml
darklua = { github = "seaofvoices/darklua", version = "=0.13.1" }
```
## [Aftman](https://github.com/LPGhatguy/aftman)
With Aftman, run:
```
aftman add seaofvoices/darklua
```
# License
darklua is available under the MIT license. See [LICENSE.txt](LICENSE.txt) for details.