Nut/README.md

36 lines
1.3 KiB
Markdown

# Nut
[![CI build](https://github.com/HamedMasafi/Nut/workflows/CI%20build/badge.svg)](https://github.com/HamedMasafi/Nut/actions)
[![GitLicense](https://gitlicense.com/badge/hamedmasafi/nut)](https://gitlicense.com/license/hamedmasafi/nut)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f3802610beb946068f6cd2c2b6608a8b)](https://www.codacy.com/app/HamedMasafi/Nut?utm_source=github.com&utm_medium=referral&utm_content=HamedMasafi/Nut&utm_campaign=Badge_Grade)
## Advanced, Powerful and easy to use ORM for Qt5
## Features
- Easy to use
- Support PosgtreSQL, MySQL, SQLite and Microsoft Sql Server
- Automatically create and update database
- Support for IDE autocomplete. No hard-coding is needed
- Detecting table joins
- Support common C++ and Qt-specific types ([Full list](doc/datatypes.md))
## Getting started
- [Sample codes](doc/start.md)
- [Shared pointer and regular mode](doc/sharedpointer.md)
- [Create database class](doc/database.md)
- [Create table class](doc/table.md)
- [Using queries](doc/query.md)
- [Supported data types](doc/datatypes.md)
## Help needed!
We need more documentation or wiki. If you can help to improve docs please fork now!
### Donate
Bitcoin address: 1Dn1WHKkaxanXe4cTGDk4cFRRABxLUpEVj
![Wallet address](btc-qr.png)
For more information read [Wiki](wiki).