From 92d13e8ee54215298fe7929e7769ba85cb4c8492 Mon Sep 17 00:00:00 2001 From: Geoffroy Couprie Date: Sun, 11 Sep 2016 16:31:28 -0600 Subject: [PATCH] Make documentation easier to find --- .gitignore | 2 +- README.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 2e4c028..9f8e5de 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,4 @@ oldsrc/ realworld/ src/generator.rs .DS_Store -docs/ +private-docs/ diff --git a/README.md b/README.md index 11bbc65..c68316f 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,10 @@ nom can handle any format, binary or textual, with grammars from regular to cont If you need any help developing your parsers, please ping `geal` on IRC (mozilla, freenode, geeknode, oftc), go to `#nom` on Mozilla IRC, or on the [Gitter chat room](https://gitter.im/Geal/nom). +Reference documentation is available [here](http://rust.unhandledexpression.com/nom/). + +Various design documents and tutorials can be found in the [docs directory](https://github.com/Geal/nom/tree/master/docs). + ## Features Here are the current and planned features, with their status: @@ -30,8 +34,6 @@ Here are the current and planned features, with their status: - [x] **safe parsing**: nom leverages Rust's safe memory handling and powerful types, and parsers are routinely fuzzed and tested with real world data. So far, the only flaws found by fuzzing were in code written outside of nom - [x] **speed**: benchmarks have shown that nom parsers often outperform many parser combinators library like Parsec and attoparsec, some regular expression engines and even handwritten C parsers -Reference documentation is available [here](http://rust.unhandledexpression.com/nom/). - Some benchmarks are available on [Github](https://github.com/Geal/nom_benchmarks). ## Installation