Skip to content

Commit

Permalink
Make it almost release-ready.
Browse files Browse the repository at this point in the history
  • Loading branch information
drewc committed Jun 3, 2015
1 parent 5c55c0a commit 25a5fa3
Show file tree
Hide file tree
Showing 69 changed files with 1,675 additions and 21,470 deletions.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2010-2015 Drew Crampsie

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.
43 changes: 43 additions & 0 deletions README.org
@@ -0,0 +1,43 @@
SMUG : Super Monadic Über Go-into

~SMUG~ is a library for parsing text, based on _monadic parser
combinators_. Using a simple technique from the functional
programming camp, ~SMUG~ makes it simple to create quick extensible
recursive descent parsers without funky syntax or impenetrable
macrology.

* Features

- parsers are first class values written in basic lisp
- non-deterministic infinite look-ahead
- easy to learn, easy to use
- extensible input protocol : parse strings, streams, lists etc
- in-depth tutorial : no previous experience required.

* Download and Install

#+BEGIN_SRC sh
cd ~/quicklisp/local-projects
git clone https://github.com/drewc/smug.git
#+END_SRC

#+BEGIN_SRC lisp
(ql:quickload :smug)
#+END_SRC

* Documentation

See [[file:doc/smug.org][doc/smug.org]]

* Support

https://github.com/drewc/smug/issues or mailto:me@drewc.ca

* Licence

The MIT License (MIT)

Copyright (c) 2010-2015 Drew Crampsie

see [[file:LICENSE][LICENSE]]

3 changes: 0 additions & 3 deletions README.txt

This file was deleted.

2 changes: 0 additions & 2 deletions doc/export

This file was deleted.

23 changes: 0 additions & 23 deletions doc/literate.org

This file was deleted.

0 comments on commit 25a5fa3

Please sign in to comment.