Giters

hoelzro / lua-repl

A Lua REPL implemented in Lua for embedding in other programs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation Improvements

hoelzro opened this issue · comments

commented

I've been told by some that the documentation could use some work. Here's what I have in mind:

  • More clearly reference PLUGINS.md from README.md
  • More clearly reference rep.lua from README.md
  • Make sure that autocompletion is talked up in plugins.md (and mention in readme that many default/optional behaviors are present there)
  • Make sure documentation on ~/.rep.lua is clear
  • Move docs into doc/

The rule of thumb is that a first-time user of Lua should be able to fairly quickly understand how to install, run, and customize the example REPL (rep.lua), and seasoned users should be able to write plugins and contribute to the project with ease.