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