Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme with logo #170

Merged
merged 6 commits into from
Jan 21, 2024
Merged
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
9 changes: 6 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
name: Test

on:
workflow_dispatch:
pull_request:
types:
- edited
- opened
- reopened
- synchronize
schedule:
- cron: "0 0 * * 0"

jobs:
test:
runs-on: ubuntu-latest
name: Erlang/OTP ${{matrix.otp}}
strategy:
matrix:
otp: ['24.3', '25.3']
rebar3: ['3.20']
otp: ['24', '25', '26']
rebar3: ['3.22']
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: erlef/setup-beam@v1
with:
otp-version: ${{matrix.otp}}
Expand Down
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
Luerl - an implementation of Lua in Erlang
==========================================
# Luerl

*An implementation of Lua in Erlang*

[![Build Status][gh-actions-badge]][gh-actions]
[![Luerl Versions][luerl-badge]][luerl]
[![Erlang Versions][erlang-badge]][versions]
[![Tag][github-tag-badge]][github-tag]

[![Project Logo][logo]][logo-large]

**Alert**: The migration from Lua 5.2 to 5.3 is very much Work-In-Progress. Please test it but there are as yet no guratantees.

## About

The migration from Lua 5.2 to 5.3 is very much Work-In-Progress. Please test it but there are as yet no guratantees.
--------------------------------------------------------------------------------------------------------------------
Luerl is an implementation of standard Lua 5.3 written in Erlang/OTP.

Lua is a powerful, efficient, lightweight, embeddable scripting language common in games, IoT devices, AI bots, machine learning and scientific computing research.
Expand All @@ -15,11 +25,23 @@ Through the use of Erlang functions, Luerl can be augmented to cope with a wide

Luerl is implemented as a library, written in clean Erlang/OTP. For more information, read the [documentation](https://github.com/rvirding/luerl/wiki) and follow the [get started](https://github.com/rvirding/luerl/wiki/0.2-Getting-started) tutorial. You may also browse the [examples](https://github.com/rvirding/luerl/tree/develop/examples).

Join the Community
------------------
## Join the Community

[Luerl on Slack](https://luerl.slack.com), join by requesting an invite [here](https://erlef.org/slack-invite/luerl)

[Luerl Forum - Erlang Forums](https://erlangforums.com/luerl)

Luerl embraces both [#Erlang](https://twitter.com/hashtag/erlang?src=hash) and [#LuaLang](https://twitter.com/hashtag/lualang?src=hash) communities and ecosystems.

[//]: ---Named-Links---

[logo]: priv/images/logo.png
[logo-large]: priv/images/logo-large.png
[gh-actions-badge]: https://github.com/rvirding/luerl/workflows/Test/badge.svg
[gh-actions]: https://github.com/rvirding/luerl/actions
[luerl]: https://github.com/rvirding/luerl
[luerl-badge]: https://img.shields.io/badge/luerl-1.1-blue.svg
[erlang-badge]: https://img.shields.io/badge/erlang-24%20to%2026-blue.svg
[versions]: https://github.com/rvirding/luerl/blob/master/.github/workflows/ci.yml
[github-tag]: https://github.com/rvirding/luerl/tags
[github-tag-badge]: https://img.shields.io/github/tag/rvirding/luerl.svg
Binary file added priv/images/logo-large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added priv/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion src/luerl.app.src
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@
{links, [{"Github", "https://github.com/rvirding/luerl"}]},
{files, ["README.md", "LICENSE", "VERSION", "src", "doc", "ebin",
"examples", "include", "test", "rebar.*", "*akefile",
"*.escript"]}
"*.escript"]},
{exclude_files, ["priv/images/*"]}
]}.
Loading