diff --git a/docs/building/hello-world.mdx b/docs/building/hello-world.mdx index 05014ed7d..39664a07f 100644 --- a/docs/building/hello-world.mdx +++ b/docs/building/hello-world.mdx @@ -41,7 +41,7 @@ import { ## Introduction -We will try to create the simplest working application in the terminal with the `CMake` and in the `QtCreator` IDE with the `qmake`. +We will try to create the simplest working console application, in the terminal with the `CMake` and in the `QtCreator` IDE with the `qmake`. The `HelloWorld` example also expects the following [folders structure](building/tinyorm.mdx#folders-structure), let's create them. diff --git a/docs/building/tinyorm.mdx b/docs/building/tinyorm.mdx index 7c5391201..7a759c360 100644 --- a/docs/building/tinyorm.mdx +++ b/docs/building/tinyorm.mdx @@ -427,7 +427,7 @@ CMake multi-config generators like `Ninja Multi-Config` or `Visual Studio 16 201 | `MYSQL_PING` | `OFF` | Enable `Orm::MySqlConnection::pingDatabase()` method. | | `ORM` | `ON` | Controls the compilation of all `ORM-related` source code, when this option is `disabled`, then only the `query builder` without `ORM` is compiled. Also excludes `ORM-related` unit tests. | | `TOM` | `ON` | Controls the compilation of all `Tom-related` source code, when this option is `disabled`, then it also excludes `Tom-related` unit tests. | -| `TOM_EXAMPLE` | `OFF` | Build the `Tom` command-line application example (console application). | +| `TOM_EXAMPLE` | `OFF` | Build the `Tom` console application example. | | `TOM_MIGRATIONS_DIR` | `-` | Default migrations path for the `make:migration` command, can be an absolute or relative path (to the pwd).
Default value: `database/migrations` (relative to the pwd) | | `TOM_MODELS_DIR` | `-` | Default models path for the `make:model` command, can be an absolute or relative path (to the pwd).
Default value: `database/models` (relative to the pwd) | | `TOM_SEEDERS_DIR` | `-` | Default seeders path for the `make:seeder` command, can be an absolute or relative path (to the pwd).
Default value: `database/seeders` (relative to the pwd) | @@ -630,7 +630,7 @@ Everything is ready for build, you can press Ctrl+b to bui | `link_pkgconfig_off` | `OFF` | Link against `libmariadb` with `PKGCONFIG`.
Used only in the `MinGW` __shared__ build (exactly win32-g++\|win32-clang-g++) and when `mysql_ping` is also defined to link against `libmariadb`, [source code](https://github.com/silverqx/TinyORM/blob/main/conf.pri.example#L48).
Available when: (win32-g++\|win32-clang-g++):mysql:!static:!staticlib | | `mysql_ping` | `OFF` | Enable `Orm::MySqlConnection::pingDatabase()` method. | | `tiny_ccache_win32` | `ON` | Enable compiler cache. [Homepage](https://ccache.dev/)
It works only on Windows systems. It works well with the MSYS2 `g++`, `clang++`, `msvc`, and `clang-cl` with `msvc`. It disables `precompile_header` as they are not supported on Windows and changes the `-Zi` compiler option to the `-Z7` for debug builds as the `-Zi` compiler option is not supported ([link](https://github.com/ccache/ccache/issues/1040) to the issue). | -| `tom_example` | `OFF` | Build the `Tom` command-line application example (console application). | +| `tom_example` | `OFF` | Build the `Tom` console application example. |