You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

40 lines
2.5 KiB

11 years ago
11 years ago
  1. [![ci](https://img.shields.io/travis/pegjs/pegjs.svg)](https://travis-ci.org/pegjs/pegjs)
  2. [![coverage](https://img.shields.io/coveralls/github/pegjs/pegjs.svg)](https://coveralls.io/github/pegjs/pegjs)
  3. [![release](https://img.shields.io/npm/v/pegjs.svg)](https://www.npmjs.com/package/pegjs)
  4. [![dev](https://img.shields.io/npm/v/pegjs/dev.svg)](https://github.com/pegjs/pegjs)
  5. [![bower](https://img.shields.io/bower/v/pegjs.svg)](https://github.com/pegjs/bower)
  6. [![license](https://img.shields.io/badge/license-mit-blue.svg)](https://opensource.org/licenses/MIT)
  7. PEG.js is a simple parser generator for JavaScript that produces fast parsers with excellent error reporting. You can use it to process complex data or computer languages and build transformers, interpreters, compilers and other tools easily.
  8. > PEG.js is still very much work in progress. There are no compatibility guarantees until version 1.0
  9. ## features
  10. * Simple and expressive grammar syntax
  11. * Integrates both lexical and syntactical analysis
  12. * Parsers have excellent error reporting out of the box
  13. * Based on [parsing expression grammar](http://en.wikipedia.org/wiki/Parsing_expression_grammar) formalism - more powerful than traditional LL(*k*) and LR(*k*) parsers
  14. * Usable [from your browser](https://pegjs.org/online), from the command line, or via JavaScript API
  15. [![CrossBrowserTesting](docs/images/CBT_OS-logo_Black-H.png)](https://crossbrowsertesting.com/)
  16. ## documentation
  17. - [Getting Started](https://github.com/pegjs/pegjs/blob/master/docs/guides/getting-started.md)
  18. - [Installation](https://github.com/pegjs/pegjs/blob/master/docs/guides/installation.md)
  19. - [Generating a Parser](https://github.com/pegjs/pegjs/blob/master/docs/guides/generating-a-parser.md)
  20. - [Using the Parser](https://github.com/pegjs/pegjs/blob/master/docs/guides/using-the-parser.md)
  21. - [Grammar Syntax and Semantics](https://github.com/pegjs/pegjs/tree/master/docs/grammar)
  22. - [JavaScript API](https://github.com/pegjs/pegjs/blob/master/docs/guides/javascript-api.md)
  23. - [Plugins](https://github.com/pegjs/pegjs/blob/master/docs/guides/plugins.md)
  24. - [Compatibility](https://github.com/pegjs/pegjs/blob/master/docs/notes/compatibility.md)
  25. - [Development](https://github.com/pegjs/pegjs/blob/master/docs/notes/development.md)
  26. - [Useful Links](https://github.com/pegjs/pegjs/blob/master/docs/notes/useful-links.md)
  27. ## license
  28. Released under the [MIT License](https://opensource.org/licenses/MIT).
  29. Copyright (c) 2010-2016 [David Majda](https://majda.cz/)<br>
  30. Copyright (c) 2017+ [Futago-za Ryuu](https://github.com/futagoza)