Files
TinyORM/docs/README.mdx
silverqx 144dfdf395 docs categorized documentation
- moved docs to categories
 - updated all links

[skip ci]
2022-05-18 15:43:20 +02:00

26 lines
1.4 KiB
Plaintext

---
sidebar_position: 0
sidebar_label: 🔥 Prologue
slug: /
hide_table_of_contents: true
description: TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the QtCore and QtSql libraries. The code is written in the modern c++20 way and is well tested with the unit and functional tests.
---
# Prologue
TinyORM is a modern c++ ORM library that makes interacting with a database extremely simple. It depends on the `QtCore` and `QtSql` libraries.
The code is written in the modern c++20 way and is well tested with the unit and functional tests. Almost all the query builder methods are unit tested. The TinyORM's query builder code and the code which is responsible for obtaining relationships, is tested by functional tests against all supported databases. For now, the code coverage is not ideal but is good enough to guarantee API and behavior compatibility.
- [Dependencies](dependencies.mdx)
- [Supported Compilers](supported-compilers.mdx)
- [Database: Getting Started](database/getting-started.mdx)
- [Database: Query Builder](database/query-builder.mdx)
- [Database: Migrations](database/migrations.mdx)
- [Database: Seeding](database/seeding.mdx)
- [TinyORM: Getting Started](tinyorm/getting-started.mdx)
- [TinyORM: Relationships](tinyorm/relationships.mdx)
- [Building: TinyORM](building/tinyorm.mdx)
- [Building: Hello world](building/hello-world.mdx)
- [Building: Migrations](building/migrations.mdx)