xref: /llvm-project/bolt/docs/doxygen-mainpage.dox (revision cd7a6305851146921bcda1f6eba53db3bfe07f3a)
1*cd7a6305SAmir Ayupov/// \mainpage BOLT
2*cd7a6305SAmir Ayupov///
3*cd7a6305SAmir Ayupov/// \section main_intro Introduction
4*cd7a6305SAmir Ayupov/// Welcome to the BOLT project.
5*cd7a6305SAmir Ayupov///
6*cd7a6305SAmir Ayupov/// This documentation describes the **internal** software that makes
7*cd7a6305SAmir Ayupov/// up BOLT, not the **external** use of BOLT. There are no instructions
8*cd7a6305SAmir Ayupov/// here on how to use BOLT, only the APIs that make up the software. For
9*cd7a6305SAmir Ayupov/// usage instructions, please see the [project website](https://github.com/facebookincubator/BOLT/tree/main/bolt)
10*cd7a6305SAmir Ayupov/// for further detail.
11*cd7a6305SAmir Ayupov///
12*cd7a6305SAmir Ayupov/// \section main_caveat Caveat
13*cd7a6305SAmir Ayupov/// This documentation is generated directly from the source code with doxygen.
14*cd7a6305SAmir Ayupov/// Since BOLT is constantly under active development, what you're about to
15*cd7a6305SAmir Ayupov/// read is out of date!
16