Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

This directory contains our documentation on how to use cbmc-viewer.

The mdbook documentation explains how to use mdbook to generate documentation.

  • The file book.toml is the configuration file used by mdbook to build the documentation.
  • The directory src is the tree of markdown files that generate the "book" containing the documentation.
  • The file src/SUMMARY.md is the list of "chapters" and "subchapters" that will appear in the book. The only pages that will appear in the book are those generated from the markdown files listed in this summary.
  • The directory book will contain the html making up the book.

You can build and browse the documentation by running the following commands in this directory:

mdbook build
mdbook serve --open