Skip to content

Commit

Permalink
update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
fewkz authored May 1, 2023
1 parent ec2e0d7 commit 7519422
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,26 @@ require syntax of Luau to Roblox's require syntax, and generates a
`default.project.json`. This allows you to create testable libraries that can
also be used in Roblox by letting you write your libraries in pure Luau.

## Installation
# Installation

## Deno
This script can be executed without the need for installation using the `deno` cli as follows:
```
deno run -A https://raw.githubusercontent.com/fewkz/luau-to-rojo/main/luau-to-rojo.ts --help
```
You can also install it as a shell command with `deno install` like so:
```
deno install -A https://raw.githubusercontent.com/fewkz/luau-to-rojo/main/luau-to-rojo.ts
```

## Aftman
You can install `luau-to-rojo` via [Aftman](https://github.com/LPGhatguy/aftman)
by doing `aftman add fewkz/luau-to-rojo`, or download a binary directly from
[GitHub Releases](https://github.com/fewkz/luau-to-rojo/releases)
by doing `aftman add fewkz/luau-to-rojo`

## GitHub release
You can download a binary directly from [GitHub Releases](https://github.com/fewkz/luau-to-rojo/releases)

## How to use
# How to use

To use, run `luau-to-rojo luau-project-dir rojo-project-dir`, where
`luau-project-dir` is a path to the directory of a Luau project. It will create
Expand Down

0 comments on commit 7519422

Please sign in to comment.