Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
<style>
/* special formatting just for this document */
.md-nav--primary .md-nav__link[for=__toc] ~ .md-nav {
display: none;
}
</style>

# Contributing to L5 ❤️

Thanks for your interest in contributing to **L5**! Contributions of all kinds are welcome — from code and documentation to tutorials, examples, and teaching.

We are inspired by the *[all contributors](https://github.com/all-contributors/all-contributors.github.io)* approach to contribution to open source projects:
We are inspired by the **[all contributors](https://github.com/all-contributors/all-contributors.github.io)** approach to contribution to open source projects:

> Our community values contributions of all forms and seeks to expand the meaning of the word contributor as far and wide as possible. It includes documentation, teaching, writing code, making art, writing, design, activism, organizing, curating, or anything else you might imagine. --*from [p5.js Contributor Guidelines](https://p5js.org/contribute/contributor_guidelines/)*
> Our community values contributions of all forms and seeks to expand the meaning of the word contributor as far and wide as possible. It includes documentation, teaching, writing code, making art, writing, design, activism, organizing, curating, or anything else you might imagine. -- *from [p5.js Contributor Guidelines](https://p5js.org/contribute/contributor_guidelines/)*

If you’re new to open source, don’t worry. This guide explains **which repository to use**, **when to fork**, and **how to get started** step by step.

## Step 1: Decide what you want to contribute

L5 has **two main repositories**. Which one you use depends on *what you’re working on*.
L5 has **two main repositories**. Which one you use depends on **what you’re working on**.

### L5 - The library itself
### L5 - The library itself

Use this repository if you want to:

Expand All @@ -34,7 +41,6 @@ Use this repository if you want to:

**Repository:** <https://github.com/L5lua/L5-website>


## Step 2: Start with an issue

Before writing code or documentation, we recommend **opening an issue** to describe:
Expand All @@ -52,7 +58,6 @@ This helps avoid duplicated work and gives you a place to ask questions.

**Website issues:** <https://github.com/L5lua/L5-website/issues>


## Step 3: Fork the repository

If you want to make changes:
Expand All @@ -69,7 +74,7 @@ Most contributors work directly on the `main` branch of **their fork**.

### Example (command line)

After forking the repo on GitHub, clone *your fork*:
After forking the repo on GitHub, clone **your fork**:

```bash
git clone https://github.com/YOUR-USERNAME/L5-website.git
Expand Down Expand Up @@ -97,13 +102,13 @@ Finally, open a Pull Request on GitHub from your fork to the main repository.
- **Create educational content** like zines or video tutorials
- **Develop add-on libraries** or document Lua ecosystem integration

We follow the *All Contributors* philosophy:
We follow the **All Contributors** philosophy:

> Our community values contributions of all forms and seeks to expand the meaning of the word contributor.

## Contributors meetings

We regularly host in-person contributor meetings in NYC. All are welcome! Feel free to [reach out directly](https://leetusman.com/info/) if you'd like to learn more.
We regularly host in-person contributor meetings in NYC. All are welcome! Feel free to [reach out directly](https://leetusman.com/info/) if you'd like to learn more.

## Winter 2026 L5 Survey

Expand Down
52 changes: 10 additions & 42 deletions docs/download/index.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,20 @@
# Downloads

L5 is free open source software available for Linux, Mac, Windows, Android and iOS.

L5 programs run using LÖVE (also called Love2d), a free, open-source framework. You'll need to download both L5 and LÖVE to get started.
L5 programs run using LÖVE (also called Love2d), a free, open-source framework. Love2d is a game framework, just like Godot, Unity, or Unreal. You will use Love2d to run your L5 scripts. This is similar to using a browser to run HTML code.

Covered by this download tutorial:

## Install overview
- Download and Install Love2d
- Download and Open L5 Starter Folder

**Step-by-step install guides:**
### Step-by-step install guides

* [macOS](install-mac.md)
* [Windows](install-windows.md)
* [Linux](install-linux.md)

**Quick start:**

1. Download [Love2d](https://www.love2d.org/)
2. Download the [L5 Starter project](/L5-starter.zip) and extract it
3. Open *main.lua* in any text editor and start coding (a starter program is already there)
4. To run: drag the L5-starter folder onto the Love application, or run from command line/IDE. See [Getting Started](/getting-started) for details.

## Downloads

### L5 Starter Project (Recommended)

This compressed folder contains the *L5.lua* library, a starter *main.lua* file (with `require('L5')` already included), and a *README*.

[Download L5 Starter project](/L5-starter.zip)

### Individual Downloads

**Latest version:** [Download L5.lua](https://raw.githubusercontent.com/L5lua/L5/main/L5.lua)

**Stable release (v0.1.6):** [Download L5.lua v0.1.6](https://raw.githubusercontent.com/L5lua/L5/v0.1.6/L5.lua)

### Source code

The [L5 repository](https://github.com/L5lua/L5) is accessible for anyone interested in viewing or modifying the L5 source code. See [contributing](/contributing.md) for ways to contribute to the library or this site.

## Offline Documentation

This L5 documentation site is available for download to run offline, with or without images.

* [Download L5lua.org with images (8MB ZIP)](https://github.com/L5lua/L5-website/archive/refs/heads/gh-pages.zip)
* [Download L5lua.org without images (2MB ZIP)](https://github.com/L5lua/L5-website/archive/refs/heads/gh-pages-lite.zip)

After downloading, extract the ZIP and serve the folder with a local web server.

* For a quick local server, navigate to the extracted folder in your command line and run `python -m http.server` (Python 3) or `python -m SimpleHTTPServer` (Python 2).

## Running your programs

To get started running L5 check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.
Congratulations! You've now installed Love and have L5 on your computer and verified you can run your own programs.

Now your computer you are ready to write and [run your L5 programs](running.md).
3 changes: 1 addition & 2 deletions docs/download/install-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,4 @@ love .
It should now launch and you should see a new window open with your code sketch running.
<img src="/assets/tutorials/install/linux1.webp" alt="A yellow background window appearing on top of folder holding L5 Starter and love application" title="A yellow background window appearing on top of folder holding L5 Starter and love application" width="600" />

**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.

**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
6 changes: 3 additions & 3 deletions docs/download/install-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
1. Love is the underlying Framework that will allow L5 code to run on your computer. So we start by installing Love. Go to the [Love website](https://love2d.org) and click to download the 64-bit zipped Mac program.
![Love2d website with downloads](/assets/tutorials/install/mac1.webp "Love2d website with downloads")
2. Click **"Allow"** if it asks 'Do you want to allow downloads on "love2d.org"?' It should download to your *Downloads* folder by default.
![Alert box asking permission to download Love2d](/assets/tutorials/install/mac2test.webp "Alert box asking permission to install Love2d")
![Alert box asking permission to download Love2d](/assets/tutorials/install/mac2.webp "Alert box asking permission to install Love2d")
3. Now on your desktop (called "Finder" on macOS) open up your *Downloads* folder. You can right click and choose Open (see screenshot) or double click on Love to launch it.
![Folder with love application and L5 Starter folder](/assets/tutorials/install/mac3.webp "Folder with love application and L5 Starter folder")
4. A warning popup box opens to say the program and code is not verified by Apple since you will be writing your own custom code. If you can choose Open because you turned off restrictions, then choose Open! Otherwise, **DO NOT** move to the trash.
Expand All @@ -23,8 +23,8 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
7. From the L5lua.org Download page, [download the L5 Starter project](/L5-starter.zip).
![L5 website download page with L5 Starter](/assets/tutorials/install/mac7.webp "L5 website download page with L5 Starter")
8. Click **"Allow"** if it asks 'Do you want to allow downloads on "l5lua.org"?'
![Alert box asking permission to download L5-Starter](/assets/tutorials/install/mac8test.webp "Alert box asking permission to download L5 Starter")
![Alert box asking permission to download L5-Starter](/assets/tutorials/install/mac8.webp "Alert box asking permission to download L5 Starter")
9. Back in your downloads folder, **drag the L5-starter folder onto the Love application in the folder**. It should now launch and you should see a new window open with your code sketch.
![A yellow background window appearing on top of folder holding L5 Starter and love application](/assets/tutorials/install/mac9.webp "A yellow background window appearing on top of folder holding L5 Starter and love application")

**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](index.md) to learn more about where you can edit your code and run it.
**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
2 changes: 1 addition & 1 deletion docs/download/install-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
7. You should see a window open with a flying bird-shaped balloon and clouds, verifying that Love is now properly installed on your computer. **At this point you can close the window.**
8. Back in your downloads folder, **extract the L5-starter.zip file** the same way you extracted the Love zip file. Then **drag the L5-starter folder onto the love.exe application**. It should now launch and you should see a new window open with your code sketch.

**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.
**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
30 changes: 15 additions & 15 deletions docs/getting-started.md → docs/download/running.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
You can run L5 programs from your downloaded folder or via the command line or an Integrated Development Environment (IDE).
# Running Your Programs

IDEs such as ZeroBrane Studio, Sublime Text, VS Code, Notepad++, and SciTE all support launching LÖVE programs (the underlying framework used by L5), though require additional setup configuration not covered here.
There are two ways to run a L5 program -- one method is using the desktop and the other uses the command line interface (CLI). If you are new to computing or are unsure about the CLI, then run from the desktop!

IDEs such as ZeroBrane Studio, Sublime Text, VS Code, Notepad++, and SciTE all support launching LÖVE programs (the engine to run our L5 scripts), though require additional setup configuration not covered here.

## Running L5 from the desktop

The easiest way to run your L5 program is to drag the **folder** containing your main.lua onto the Love2d application. Remember to drag the **folder** containing `main.lua`, and not `main.lua` itself.
The easiest way to run your L5 program is to drag the **folder** containing your main.lua onto the Love2d application. Remember to drag the **folder** containing `main.lua`, and not `main.lua` itself.

It should launch and open a new window with your sketch running in it, or print an error message. If you're running the L5 Starter program, you should see a square window with a yellow background. Congratulations.

Expand All @@ -14,22 +16,16 @@ It should launch and open a new window with your sketch running in it, or print

## Running L5 from the command line

Running L5 from the command line allows you to see the output of `describe()`, `print()` and any error messages in the console.

### Linux command line

In the Terminal, you can run `love path/to/L5-starter`. Or if you are in the folder with your program, run `love .` to launch your project from the current directory.

### Windows command line

### Windows Command line
You can launch your programs from the command line and add the `--console` flag to be able to see print() and error() output as well:

```
"C:\Program Files\LOVE\love.exe" --console "C:\Users\<YourUsername>\Desktop\L5-starter"
"C:\Program Files\LOVE\love.exe" --console
"C:\Users\<YourUsername>\Desktop\L5-starter"
```

Replace `<YourUsername>` and `Desktop\L5-starter` with your actual username and the location of your program folder.

### macOS command line
### macOS Command Line

There are a few extra steps to smoothly set up command line usage for L5 in the command line on Mac.

Expand Down Expand Up @@ -79,6 +75,10 @@ source ~/.zshrc
love ~/path/to/my-program
```

---
### Linux Command line

In the Terminal, you can run `love path/to/L5-starter`. Or if you are in the folder with your program, run `love .` to launch your project from the current directory.

*Instructions adapted from [Love2d wiki: Getting Started](https://www.love2d.org/wiki/Getting_Started), GNU Free Documentation License 1.3.*

Amazing! Now you are ready to start learning with [First Steps](../tutorials/first-steps.md). If you are familiar with Lua, p5.js, or Processing already, you should take a look at [L5 for Processing-p5.js Programmers](../L5-for-processingp5.md).
Loading