Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions on how to build documentation #377

Merged
merged 2 commits into from
Sep 16, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ This is a family of XSLT 2.0 stylesheets to transform TEI XML documents to vario

and should not be treated as the definitive view of the TEI Consortium.

For more information, see https://tei-c.org/tools/stylesheets/

## Prerequisites
The package assumes that you have several additional tools installed. Their availability on your system can be verified by issuing the command `make check`.

Expand All @@ -31,6 +33,16 @@ bin/teitornc --odd ../TEI/P5/Exemplars/tei_lite.odd tei_lite.rnc
```
will produce a RelaxNG Compact Syntax schema for TEI Lite.

## Documentation

To build the documentation, run:

```bash
make doc
```

It will then be available at `release/xslcommon/doc/tei-xsl/index.html`.
=======

## About the Text Encoding Initiative (TEI)

Expand Down