Skip to content

Commit

Permalink
add cargo note about the installation method
Browse files Browse the repository at this point in the history
  • Loading branch information
orpos committed Nov 23, 2024
1 parent 270b9d9 commit 3dfbd33
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Kaledis is a tool for allowing Luau to be used with Love2D via transpiling, alon

It has many resources to make your life much easier when using Love2D:
* Transpiles Luau into compatible Love2D code, allowing type annotations, libraries and other features to be implemented.
* Automatically manages and provides Love2D installations.
* Automatically manages and provides Love2D installations. (WIP)
* Simple commands and CLI, you'll get the hang of it in no time.
* Easily create & ship your project to the current OS you build the project in.
* A more friendly frontend configuration framework, using a TOML file instead of a *conf.lua*
Expand All @@ -18,6 +18,11 @@ It has many resources to make your life much easier when using Love2D:
## Installation
*Note: The only available builds are for Windows. MacOS and Linux builds have not been tested.*

### From Cargo
We currently are waiting for [Dal](https://github.com/CavefulGames/dal) to make some fields public or implement a constructor with changeable params.

The [package](https://crates.io/crates/kaledis) is just a placeholder for now.

### From Releases
Go to the Releases page and download the `kaledis.exe` file. *Windows only.*

Expand Down

0 comments on commit 3dfbd33

Please sign in to comment.