|
| 1 | +# User guide |
| 2 | + |
| 3 | +## [System requirements](system-requirements) |
| 4 | + |
| 5 | +## [UnitTestBot server](install-server) |
| 6 | + |
| 7 | +* [**Linux**](linux) |
| 8 | + * [Local installation](install-server-on-ubuntu) |
| 9 | + * [Remote installation via Docker](linux-remote) |
| 10 | +* [**Windows**](windows) |
| 11 | + * [Local installation via WSL](windows-local) |
| 12 | + * [Remote installation via Docker](windows-remote) |
| 13 | +* [**macOS**](macos) |
| 14 | + |
| 15 | +## [UnitTestBot client](install_client) |
| 16 | + |
| 17 | +### [Visual Studio Code plugin](vscode-overall) |
| 18 | + |
| 19 | +* [Install and configure the plugin](vscode-install-and-configure) |
| 20 | +* [Generate tests with default configuration](vscode-generate-tests) |
| 21 | +* [Fine-tune test generation](vscode-fine-tune) |
| 22 | +* [Get use of test results](vscode-get-use-of-results) |
| 23 | + |
| 24 | +### [CLion plugin](clion-overall) |
| 25 | + |
| 26 | +* [Install and configure the plugin](clion-install-and-configure) |
| 27 | +* [Generate tests with default configuration](clion-generate-tests) |
| 28 | +* [Fine-tune test generation](clion-fine-tune) |
| 29 | +* [Get use of test results](clion-get-use-of-results) |
| 30 | + |
| 31 | +## [GitHub Action](GitHub-action) |
| 32 | + |
| 33 | +## Supported syntax |
| 34 | + |
| 35 | +* [C](c-syntax) |
| 36 | +* [C++](cpp-syntax) |
| 37 | + |
| 38 | +# Contributor guides |
| 39 | + |
| 40 | +## Developer guides |
| 41 | + |
| 42 | +* [To do](todo) |
| 43 | +* [Create a release](create-release) |
| 44 | +* [Testing release in Docker](testing-release-utbotcpp-in-docker) |
| 45 | +* [Label usage guideline](Labels-usage-guidelines) |
| 46 | +* [Troubleshooting](troubleshooting) |
| 47 | + |
| 48 | +## Advanced |
| 49 | + |
| 50 | +* [How UTBot Works](utbot-inside) |
| 51 | +* [How types are fetched and stored](types-fetching) |
| 52 | +* [Makefiles](makefiles) |
| 53 | +* [Symbolic Stdin](symbolic-stdin) |
| 54 | +* [UTBot Logging Principles](utbot-logging) |
| 55 | +* [Targets](targets) |
| 56 | +* [Compile database](compile-database) |
| 57 | +* [Coverage](coverage) |
| 58 | +* [Generating and running test](generating-and-running-tests) |
| 59 | +* [Incrementality](incrementality) |
| 60 | +* [Linking bitcode](linking-bitcode) |
| 61 | +* [Preparing source for klee](preparing-sources-for-klee) |
| 62 | +* [Stubs inside](stubs-inside) |
| 63 | +* [KLEE patches](klee-patches) |
| 64 | +* [Lazy initialization](LI) |
| 65 | +* [Symcretes](Symcretes) |
| 66 | +* [Objects of symbolic size](Symsizes) |
0 commit comments