Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dibyendumajumdar committed Nov 20, 2022
1 parent 1e90ac2 commit 2862027
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions readthedocs/ravi-overview.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
=========================
Ravi Programming Language
=========================
.. image:: https://travis-ci.org/dibyendumajumdar/ravi.svg?branch=master
:target: https://travis-ci.org/dibyendumajumdar/ravi
.. image:: https://github.com/dibyendumajumdar/ravi/workflows/build/badge.svg
:target: https://github.com/dibyendumajumdar/ravi

Ravi is a dialect of `Lua <http://www.lua.org/>`_ with limited optional static typing and
features a JIT compiler powered by `MIR <https://github.com/vnmakarov/mir>`_ as well as experimental support for AOT compilation to native code.
features a JIT compiler powered by `MIR <https://github.com/vnmakarov/mir>`_ as well as support for AOT compilation to native code.
The name Ravi comes from the Sanskrit word for the Sun.
Interestingly a precursor to Lua was `Sol <http://www.lua.org/history.html>`_ which had support for
static types; Sol means the Sun in Portugese.
Expand All @@ -30,17 +30,17 @@ over maximum performance. For more detailed comparison please refer to the docum

Features
========
* Optional static typing - for details `see the reference manual <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-reference.html>`_.
* Optional static typing
* Type specific bytecodes to improve performance
* Compatibility with Lua 5.3 (see Compatibility section below)
* Generational GC from Lua 5.4
* ``defer`` statement for releasing resources
* Compact JIT backend `MIR <https://github.com/vnmakarov/mir>`_.
* A `distribution with batteries <https://github.com/dibyendumajumdar/Suravi>`_.
* A `Visual Studio Code debugger extension <https://marketplace.visualstudio.com/items?itemName=ravilang.ravi-debug>`_ - interpreted mode debugger.
* A new compiler framework for `JIT and AOT compilation <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-compiler.html>`_.
* `AOT Compilation to shared library <https://github.com/dibyendumajumdar/ravi/tree/master/aot-examples>`_.
* Preview feature: Ability to `embed C code snippets <https://github.com/dibyendumajumdar/ravi-compiler/wiki/Embedding-C>`_.
* Compact JIT backend `MIR <https://github.com/vnmakarov/mir>`_
* A `distribution with batteries <https://github.com/dibyendumajumdar/Suravi>`_
* A `Visual Studio Code debugger extension <https://marketplace.visualstudio.com/items?itemName=ravilang.ravi-debug>`_ - interpreted mode debugger
* A new compiler framework for `JIT and AOT compilation <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-compiler.html>`_
* `AOT Compilation to shared library <https://github.com/dibyendumajumdar/ravi/tree/master/aot-examples>`_
* Preview feature: Ability to `embed C code snippets <https://github.com/dibyendumajumdar/ravi-compiler/wiki/Embedding-C>`_

Articles about Ravi
===================
Expand All @@ -49,10 +49,10 @@ Articles about Ravi

Documentation
=============
* For the Lua extensions in Ravi see the `Reference Manual <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-reference.html>`_.
* `Reference Manual <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-reference.html>`_.
* `MIR JIT Build instructions <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-mir-instructions.html>`_.
* Also see `Ravi Documentation <http://the-ravi-programming-language.readthedocs.org/en/latest/index.html>`_.
* and the slides I presented at the `Lua 2015 Workshop <http://www.lua.org/wshop15.html>`_.
* `Lua 2015 Workshop <http://www.lua.org/wshop15.html>`_.
* `Lua 2022 Workshop <https://www.lua.org/wshop22.html>`_.

Lua Goodies
===========
Expand Down

0 comments on commit 2862027

Please sign in to comment.