Skip to content

Commit

Permalink
Documentation refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
dibyendumajumdar committed Jul 27, 2018
1 parent 6ad06fe commit 849e155
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
16 changes: 7 additions & 9 deletions readthedocs/ravi-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,20 @@ over maximum performance. For more detailed comparison please refer to the docum

Features
========
* Optional static typing - for details `see the reference manual <ravi-reference.rst>`_.
* Optional static typing - for details `see the reference manual <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-reference.html>`_.
* Type specific bytecodes to improve performance
* Compatibility with Lua 5.3 (see Compatibility section below)
* `LLVM <http://www.llvm.org/>`_ powered JIT compiler
* `Eclipse OMR <https://github.com/eclipse/omr>`_ powered JIT compiler
* `Eclipse OMR <https://github.com/dibyendumajumdar/nj>`_ powered JIT compiler
* Built-in C pre-processor, parser and JIT compiler
* A `distribution with batteries <https://github.com/dibyendumajumdar/ravi-distro>`_ is in the works -
this will provide ready made binary downloads of Ravi/Lua with select high quality libraries.
* A `distribution with batteries <https://github.com/dibyendumajumdar/ravi-distro>`_.

Documentation
=============
* For the Lua extensions in Ravi see the `Reference Manual <ravi-reference.rst>`_.
* `Build instructions <ravi-build-instructions.rst>`_.
* For the Lua extensions in Ravi see the `Reference Manual <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-reference.html>`_.
* `Build instructions <https://the-ravi-programming-language.readthedocs.io/en/latest/ravi-build-instructions.html>`_.
* Also see `Ravi Documentation <http://the-ravi-programming-language.readthedocs.org/en/latest/index.html>`_.

Also see the slides I presented at the `Lua 2015 Workshop <http://www.lua.org/wshop15.html>`_.
* and the slides I presented at the `Lua 2015 Workshop <http://www.lua.org/wshop15.html>`_.

Lua Goodies
===========
Expand Down Expand Up @@ -92,7 +90,7 @@ History
- Embedded C compiler using dmrC project (C JIT compiler)
- Additional type annotations
* 2018
- Added Eclipse OMR JIT backend
- Implemented Eclipse OMR JIT backend

License
=======
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/ravi-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ The type of a slice is the same as that of the underlying array - hence slices g

Each slice holds an internal reference to the underlying array to ensure that the garbage collector does not reclaim the array while there are slices pointing to it.

For an example use of slices please see the `matmul1.ravi <https://github.com/dibyendumajumdar/ravi/blob/master/ravi-tests/matmul1.ravi>`_ benchmark program in the repository. Note that this feature is highly experimental and not very well tested.
For an example use of slices please see the `matmul1_ravi.lua <https://github.com/dibyendumajumdar/ravi/blob/master/ravi-tests/matmul1_ravi.lua>`_ benchmark program in the repository. Note that this feature is highly experimental and not very well tested.

Examples
--------
Expand Down

0 comments on commit 849e155

Please sign in to comment.