Documentation would be a good community add

  • From: William Adams <william_a_adams@xxxxxxxxxxx>
  • To: "luajit@xxxxxxxxxxxxx" <luajit@xxxxxxxxxxxxx>
  • Date: Mon, 24 Aug 2015 14:36:52 +0000

As long as we're planning out the future of LuaJIT, I think right up there with

test suites, and possibly more important, is some documentation.


We have a bare minimum set on the luajit web pages, and the rest is in code,

this list, and a few notables like the dynasm stuff.


I think there would be benefit to having some thorough documentation,
particularly

highlighting the very fine points of LuaJIT, such as the FFI, with tons of
worked examples.


Setting up a wiki or some other mechanism for this, is pretty much all that is
required. Perhaps a rough table of contents, and then the interested authors
can have at it.


I would love to contribute programming pearls in the FFI category.


I could imagine some contributions in the "performance" category, such as
pearls from snabb switch, graphics, matrix routines.


Basically, highlight all the places where LuaJIT stands out from standard Lua.
If it just hangs on 'JIT', that's not quite enough for longevity.

===============================
- Shaping clay is easier than digging it out of the ground.

Other related posts: