= External Debug Security

== License

This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0). For details, see the link:LICENSE[LICENSE] file.

== Contributors

The list of contributors to this specification is maintained in the link:contributors.adoc[contributors] file.

For guidelines on how to contribute, refer to the link:CONTRIBUTING.md[CONTRIBUTING] file.

== Building the Document

=== Prerequisites

To build the document, you'll need the following tools installed on your system:

• Make
• asciiDoctor-pdf, asciidoctor-bibtex, asciidoctor-diagram and asciidoctor-mathematical
• wavedrom
• Docker

=== Cloning the Repository

git clone --recurse-submodules https://github.com/riscv-non-isa/riscv-external-debug-security

==== Setting Environment Variables

These variables can be overridden by setting environment variables on your system. Here's how you can do it in Linux and MacOS:

export VERSION=v1.2.3
export REVMARK=Release
export PDF_RESULT=spec.pdf

=== Building the Documentation

To start the build process, run cd ./riscv-external-debug-security && make build.

The Makefile script will check the availability of Docker on your system:

• If Docker is available, the documentation will be built inside a Docker container using the image riscvintl/riscv-docs-base-container-image:latest. This ensures a consistent build environment across different systems.
• If Docker is not available, the documentation will be built directly on your system using the installed tools.

The documentation is generated from the AsciiDoctor source files in your project. The primary source file is specified by the HEADER_SOURCE variable in the Makefile.

The build process utilizes several options, including theming and font settings, and generates a PDF document as output.

=== Cleaning up

To clean up the generated files, run make clean. This will remove the generated PDF file.