diff --git a/README.md b/README.md index e2e2753..3701fb6 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,23 @@ -Master XSLT stylesheets for the INFO database authoring framework. +# Master XSLT stylesheets for the INFO database authoring framework You will need SAXON-B installed in order to process these successfully. The final released version of SAXON-B is 9.1.0.8. Earlier versions may not support the required features, and later versions change the architecture in ways that will probably break this framework! To install: - % git clone https://github.com/Otago-InfoSci-Database/XML.git - % cd XML - % make +```bash + git clone https://github.com/Otago-InfoSci-Database/XML.git + cd XML + make +``` You’ll need to have the XML Entity Resolver set up with a catalog that includes the generated `.xsl` files in this directory. The usual approach is to create somewhere (e.g., `~/Library/Catalogs` under Mac OS X) a `catalog.xml` file that includes URI mappings for all the local `.xsl` files, then create somewhere (e.g., `~/Library/Java`) a `CatalogManager.properties` file that tells the resolver where to find catalog files (both user and system). Ensure that `CatalogManager.properties` or more likely its containing directory is in your Java class path. See the `configuration` directory for examples of both these files that you can use as a template. To update: - % git pull - % make +```bash + git pull + make +``` Documents that use the framework depend on the master stylesheets, and so will automatically rebuild from scratch the next time they are built.