From 4d348e0609d93a5298ed0d5f2fb33874d8ee9e99 Mon Sep 17 00:00:00 2001 From: Dibyendu Majumdar Date: Thu, 23 Jul 2020 19:28:36 +0100 Subject: [PATCH] Update readme / intro --- README.rst | 7 ++++--- readthedocs/ravi-overview.rst | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 9256e56..b786e72 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,7 @@ Ravi Programming Language .. image:: https://travis-ci.org/dibyendumajumdar/ravi.svg?branch=master :target: https://travis-ci.org/dibyendumajumdar/ravi -Ravi is a derivative/dialect of `Lua 5.3 `_ with limited optional static typing and +Ravi is a dialect of `Lua `_ with limited optional static typing and features `MIR `_ and `LLVM `_ powered JIT compilers. The name Ravi comes from the Sanskrit word for the Sun. Interestingly a precursor to Lua was `Sol `_ which had support for @@ -52,6 +52,7 @@ Lua Goodies * `An Introduction to Lua `_ attempts to provide a quick overview of Lua for folks coming from other languages. * `Lua 5.3 Bytecode Reference `_ is my attempt to bring up to date the `Lua 5.1 Bytecode Reference `_. * A `patch for Lua 5.3 `_ implements the 'defer' statement. +* A `patch for Lua 5.4 `_ implements the 'defer' statement. Lua 5.4 Position Statement ========================== @@ -61,7 +62,7 @@ Lua 5.4 relationship to Ravi is as follows: * New random number generator - back-ported to Ravi. * Multiple user values can be associated with userdata - under consideration. * ```` variables - not planned. -* ```` variables - Ravi has ``'defer'`` statement which is better option in my opinion, hence no plans to support ```` variables. +* ```` variables - Ravi has ``'defer'`` statement which is the better option in my opinion, hence no plans to support ```` variables. * Interpreter performance improvements - these are beneficial to Lua interpreter but not to the JIT backends, hence not much point in back-porting. * Table implementation changes - under consideration. * String to number coercion is now part of string library metamethods - back-ported to Ravi. @@ -76,7 +77,7 @@ Ravi should be able to run all Lua 5.3 programs in interpreted mode, but followi * Values crossing from Lua to Ravi will be subjected to typechecks should these values be assigned to typed variables. * Upvalues cannot subvert the static typing of local variables (issue #26) when types are annotated. * Certain Lua limits are reduced due to changed byte code structure. These are described below. -* Ravi uses an extended bytecode which means it is not compatible with Lua 5.3 bytecode. +* Ravi uses an extended bytecode which means it is not compatible with Lua 5.x bytecode. * Ravi incorporates the new Generational GC from Lua 5.4, hence the GC interface has changed. +-----------------+-------------+-------------+ diff --git a/readthedocs/ravi-overview.rst b/readthedocs/ravi-overview.rst index 9256e56..b786e72 100644 --- a/readthedocs/ravi-overview.rst +++ b/readthedocs/ravi-overview.rst @@ -4,7 +4,7 @@ Ravi Programming Language .. image:: https://travis-ci.org/dibyendumajumdar/ravi.svg?branch=master :target: https://travis-ci.org/dibyendumajumdar/ravi -Ravi is a derivative/dialect of `Lua 5.3 `_ with limited optional static typing and +Ravi is a dialect of `Lua `_ with limited optional static typing and features `MIR `_ and `LLVM `_ powered JIT compilers. The name Ravi comes from the Sanskrit word for the Sun. Interestingly a precursor to Lua was `Sol `_ which had support for @@ -52,6 +52,7 @@ Lua Goodies * `An Introduction to Lua `_ attempts to provide a quick overview of Lua for folks coming from other languages. * `Lua 5.3 Bytecode Reference `_ is my attempt to bring up to date the `Lua 5.1 Bytecode Reference `_. * A `patch for Lua 5.3 `_ implements the 'defer' statement. +* A `patch for Lua 5.4 `_ implements the 'defer' statement. Lua 5.4 Position Statement ========================== @@ -61,7 +62,7 @@ Lua 5.4 relationship to Ravi is as follows: * New random number generator - back-ported to Ravi. * Multiple user values can be associated with userdata - under consideration. * ```` variables - not planned. -* ```` variables - Ravi has ``'defer'`` statement which is better option in my opinion, hence no plans to support ```` variables. +* ```` variables - Ravi has ``'defer'`` statement which is the better option in my opinion, hence no plans to support ```` variables. * Interpreter performance improvements - these are beneficial to Lua interpreter but not to the JIT backends, hence not much point in back-porting. * Table implementation changes - under consideration. * String to number coercion is now part of string library metamethods - back-ported to Ravi. @@ -76,7 +77,7 @@ Ravi should be able to run all Lua 5.3 programs in interpreted mode, but followi * Values crossing from Lua to Ravi will be subjected to typechecks should these values be assigned to typed variables. * Upvalues cannot subvert the static typing of local variables (issue #26) when types are annotated. * Certain Lua limits are reduced due to changed byte code structure. These are described below. -* Ravi uses an extended bytecode which means it is not compatible with Lua 5.3 bytecode. +* Ravi uses an extended bytecode which means it is not compatible with Lua 5.x bytecode. * Ravi incorporates the new Generational GC from Lua 5.4, hence the GC interface has changed. +-----------------+-------------+-------------+