Update the documentation

[xens]

Hi scandyna,

your project looks amazing, took me 1h to clone your repo seems to be a huge thing ! Would be great to have an overview of your project in the project front-page, so users would know exactly what the program is doing (and according to the number of lines of code it does a lots of things!). Few things that should IMHO be in the frontpage

• Quick overview of the program
• List of supported features
• List of supported hardware
• Screenshots
• Updated version of the README (you're still mentioning Ubuntu 11.xx)

I would also remove the page in the wiki, as it's a duplicate of the README that everyone will see when accessing your project. It will me more visible there.

Let me know if I can help.

+++
Romain

[scandyna]

Hi xens,

thanks for the migration of README file, it's now merged to experimental branch.
I know that the documentation is very old, and now completely wrong. This is mainly due to the amount of changes already done, and those that still come in future. Experience shows that many classes are very badly designed, and they need to be fixed.

Currently, the main task is the database schema description. To avoid creating SQL to describe the schema for every database engine, it's possible to describe them in a common manner in C++. Of course, this does not allow DBMS specific features, especially in current version that is still basic, but provides a enough easy way to describe tables and views creation (and also let the compiler catch some mistakes). Another important tool on database side is a way to migrate from a database to another, witch is also in progress.

Because of all changes that are needed, and that always breaks the whole library, I will let this issue open.

Your help is welcome. For example, the only icons present in the project are system icons as described here: http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html

++
Philippe

[scandyna]

The Wiki is currently disabled, because it does not provide any interesting information.
README.md should now be up to date, and explains how to get, compile and use Mdt.
This was all tested on Linux (Ubuntu 16.04) and Windows (A freshly installed Windows 10).