Skip to content

Commit

Permalink
build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
matiasvlevi committed Apr 28, 2024
1 parent e9b9bfd commit 16e2d41
Showing 1 changed file with 31 additions and 12 deletions.
43 changes: 31 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

<h4 align="center">Lua interpreter for Creative Coding</h4>

Provides a similar experience to <a href="https://p5js.org">p5.js</a> with opengl wrappers.

> We are not and we do not claim to be affiliated with p5.js or the processing foundation
<br/>


Expand All @@ -23,21 +27,46 @@ function draw()
end
```

<br/>

# Build

## Build
You can download a built executable for lu5 [here](https://github.com/matiasvlevi/lu5/releases), or you can build it yourself assuming you have the right dependencies installed (glfw, lua)

### GNU/Linux

Build with `make`

```sh
make
```

You can then install it on linux with
you can then install the executable in `/usr/bin`

```sh
sudo make install
```

<br/>

### Windows

Windows builds are done in an [MSYS2](https://www.msys2.org/) environement with mingw64 installed.

Install dependencies

```
pacman -S mingw-w64-x86_64-toolchain mingw-w64-x86_64-lua mingw-w64-x86_64-glfw
```

build

```
make PLATFORM=win
```

<br/>


## Running Lua Sketches

Expand All @@ -53,17 +82,7 @@ lu5 file.lua

### Command utilities

Help menu

```sh
lu5 --help
```

Create a boiler plate sketch source file

```sh
lu5 --init file.lua
```
<br>

### Preview
Expand Down

0 comments on commit 16e2d41

Please sign in to comment.