Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added COPYRIGHT, README and release.
  • Loading branch information
hanjos committed Nov 23, 2007
1 parent b5dd71c commit 865bec7
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 0 deletions.
26 changes: 26 additions & 0 deletions COPYRIGHT
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Leg

Copyright � 2007 Humberto Saraiva Nazareno dos Anjos.

Leg is available under the MIT license. Leg uses LPeg
(http://www.inf.puc-rio.br/~roberto/lpeg.html), which is also under the MIT
license.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
73 changes: 73 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
Leg 0.1.2
=========

This is a release of Leg, a Lua library exporting a complete Lua 5.1 grammar
and a small API for user manipulation.


Dependencies
------------

* You need, understandably, to have Lua 5.1 up and running to be able to use
this library :)

* Also, Leg uses LPeg 0.7 extensively for pattern matching, so LPeg is
expected be installed. You can get LPeg at

http://www.inf.puc-rio.br/~roberto/lpeg.html


Basic Installation
------------------

There are three ways to install Leg:

* `make` or `make leg`

A directory `leg` will be created in your working directory, with the
source files inside. Just put it in a LUA_PATH-visible place and you're
ready to go.

* `make install`

If you have the proper permissions, you can run `make install` and the
`leg` directory with the source files will be put in a specific path.
Tweak Makefile's LUA_LIB variable to indicate the appropriate path for your
system; Makefile ships with it set to /usr/local/share/lua/5.1 .

* by hand

If you don't have or don't want to use `make`, you can just put all the
files in `src` inside a directory called `leg`, and put that directory in
your LUA_PATH.

Read the Lua Reference Manual for the LUA_PATH and the LUA_CPATH syntax
(http://www.lua.org/manual/5.1/manual.html#pdf-package.path).


Copyright
---------

See the file "COPYRIGHT".


New Stuff
---------

See the file "release".


Work to do
----------

* Improve error checking: currently it is bolted on and not extensible, and
different patterns react differently to mismatching: scanner.STRING throws
an error when a mismatch happens, but some errors simply return false and an
error message. I don't know a good way to handle this.

* A better API for grammar extensions. The current one is very ad hoc, and
requires some fine tuning to make sure it works correctly. Metalua's API
seems interesting, and was originally based on Parsec. Investigation is
under way.

* More thorough testing.
28 changes: 28 additions & 0 deletions release
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
$Id: release,v 1.1 2007/11/23 18:20:00 hanjos Exp $

Version: 0.1.2
========

API
===

* grammar.lua received two new utility functions: anyOf and listOf

Bugs
====

* adding scanner's keywords e symbols to parser's rules ended up altering
scanner.keywords and scanner.symbols as well; using grammar.complete instead
of grammar.apply does the trick.

Documentation
=============

* changes in the documentation generator made the new docs slightly different;
no big conceptual change.

* an improved README file

* a COPYRIGHT file with Leg's license

* and this release file

0 comments on commit 865bec7

Please sign in to comment.