Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
leafo committed Sep 7, 2019
1 parent 7747185 commit 9ad18e1
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
4 changes: 3 additions & 1 deletion install-lua/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
[![Actions Status](https://github.com/leafo/gh-actions-lua/workflows/test/badge.svg)](https://github.com/leafo/gh-actions-lua/actions)


Builds Lua and installs it into the `.lua/` directory in the working directory.
Builds and installs Lua into the `.lua/` directory in the working directory.
Adds the `.lua/bin` to the `PATH` environment variable so `lua` can be called
directly in workflows.

For full example, see https://github.com/leafo/gh-actions-lua/blob/master/README.md

## Usage

Install Lua: (Will typically default to the latest release, 5.3.5 as of this readme)
Expand Down
28 changes: 28 additions & 0 deletions install-luarocks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# leafo/gh-actions-lua/install-lua

[![Actions Status](https://github.com/leafo/gh-actions-lua/workflows/test/badge.svg)](https://github.com/leafo/gh-actions-lua/actions)


Builds and intsalls LuaRocks from source into `.luarocks/` directory in the working directory. Configures `PATH`, `LUA_PATH`, and `LUA_CPATH` environment varibles to be able to use luarocks directly in workflows.

Depends on [`leafo/gh-actions-lua/install-lua`](https://github.com/leafo/gh-actions-lua/tree/master/install-lua) for a version of Lua.


For full example, see https://github.com/leafo/gh-actions-lua/blob/master/README.md

## Usage

Install Lua, then LuaRocks:

```yaml
- uses: leafo/gh-actions-lua/install-lua@master
- uses: leafo/gh-actions-lua/install-luarocks@master
```
## Inputs
### `luarocksVersion`

**Default**: `"3.2.0"`

Specifies which version of LuaRocks to install. Must be listed on https://luarocks.github.io/luarocks/releases/

0 comments on commit 9ad18e1

Please sign in to comment.