[NFC][opt] Improve help message (#97805)
[llvm-project.git] / bolt / docs / README.txt
blobb807dd538c1d2fab518bb8bafe780685156ddba4
1 BOLT Documentation
2 ====================
4 The BOLT documentation is written using the Sphinx documentation generator. It
5 is currently tested with Sphinx 1.1.3.
7 To build the documents into html configure BOLT with the following cmake options:
9   * -DLLVM_ENABLE_SPHINX=ON
10   * -DBOLT_INCLUDE_DOCS=ON
12 After configuring BOLT with these options the make rule `docs-bolt-html` should
13 be available.