-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
168 changed files
with
6,218 additions
and
79,139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,29 @@ | ||
# Autumn Parsing | ||
# Autumn: Extensible Parsing Combinators | ||
|
||
Soon-ish: a user manual and various UX improvements. | ||
## Documentation | ||
|
||
In the meantime, dig around | ||
src/com/norswap/autumn/test/parsing/JavaGrammarTest.java for pointers on how to | ||
use the library. | ||
Soon: a user manual. You can send me angry emails if I procrastinate for too | ||
long. | ||
|
||
In the meantime, dig around [the Autumn class][autumn] for documented entry | ||
points into the parser. There's also [a good example][java-example] that uses | ||
the bundled Java grammar. | ||
|
||
For the internals, [the ParseState class][parse-state] class has a long | ||
explanation of the concepts underlying parse state handling. For writing custom | ||
parsing expressions, look at [the ParsingExpression class][parsing-exp]. | ||
|
||
[autumn]: https://github.com/norswap/autumn/blob/master/src/com/norswap/autumn/Autumn.java | ||
|
||
[java-example]: https://github.com/norswap/autumn/blob/master/src/com/norswap/autumn/test/parsing/JavaGrammarTest.java | ||
|
||
[parse-state]: | ||
https://github.com/norswap/autumn/blob/master/src/com/norswap/autumn/parsing/state/ParseState.java | ||
|
||
[parsing-exp]: https://github.com/norswap/autumn/blob/master/src/com/norswap/autumn/parsing/ParsingExpression.java | ||
|
||
## Building | ||
|
||
make build | ||
|
||
... will output the class files under the `out/dev` directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.