project-template

OSCAL XProc3 Project Template

Use this file to document the project in the containing folder.

For an outline of full (minimal) project documentation, see the NIST Open-Source Software Repository Template.

The repository README addresses all these points on a general level (repository-wide). Given the assumption that all projects are abiding by repository guidelines, each project readme (this file) is available for documenting its specifics.

Consider describing the following here:

Project purpose, scope and goals

Who might find this useful

The project is centered on an application or family of applications. Who will use it?

What is provided

Describe, with supporting links, the software, data sets or other assets provided with the project.

How to use it

With links. (If help is extensive consider maintaining it outside the readme.)

Credits for contributors

And don't forget contact information, form for citation, etc.

Checklist checklist

To use this template for a new project —

• Copy this folder
• Rename the copy for your project
• Is GRAB-RESOURCES.xpl useful, or something like it?

  • yes Rename, comment and edit

    • Validate your new pipeline using the House Rules Schematron

  • no Delete

• (If 'no' and even if 'yes' on last question) Do you need a lib folder?
  • yes All is fine
  • no Delete and clean up .gitignore
• Update TESTING.md
• Update this file including the date at the bottom

started 20240522

---