diff options
| author | David Robillard <d@drobilla.net> | 2019-03-31 22:30:20 +0200 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2019-03-31 22:30:20 +0200 |
| commit | 43c56d347ec2fb4a8b39eea9337f6a89b51d458a (patch) | |
| tree | a903e8add0dd40b8825816118dbcd737c1b44fde /doc/mainpage.md | |
| parent | 611094ffa4014ba34e6f2c8dc083878ab6073411 (diff) | |
| download | serd-43c56d347ec2fb4a8b39eea9337f6a89b51d458a.tar.gz serd-43c56d347ec2fb4a8b39eea9337f6a89b51d458a.tar.bz2 serd-43c56d347ec2fb4a8b39eea9337f6a89b51d458a.zip | |
Add documentation main page
Diffstat (limited to 'doc/mainpage.md')
| -rw-r--r-- | doc/mainpage.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/mainpage.md b/doc/mainpage.md new file mode 100644 index 00000000..33ba7ec0 --- /dev/null +++ b/doc/mainpage.md @@ -0,0 +1,15 @@ +Serd is a lightweight and dependency-free C library for RDF serialisation which +supports [Turtle], [NTriples], [NQuads], and [TriG]. + +The complete API is documented in the [serd](@ref serd) group. It revolves +around two main types: @ref SerdReader, which reads text and fires callbacks, +and @ref SerdWriter, which writes text when driven by corresponding functions. +Both work in a streaming fashion but still support pretty-printing, so the pair +can be used to pretty-print, translate, or otherwise process arbitrarily large +documents very quickly. The stream context is maintained by @ref SerdEnv, +which stores the current base URI and set of namespace prefixes. + +[Turtle]: http://www.w3.org/TR/turtle/ +[NTriples]: http://www.w3.org/TR/n-triples/ +[NQuads]: http://www.w3.org/TR/n-quads/ +[TriG]: http://www.w3.org/TR/trig/ |