convert README.md to AsciiDoc

[rdmueller]

I think it makes sense to have only one markup format within the project. The solution architecture (/src/docs) needs to be written in AsciiDoc, so let's also convert the README to AsciiDoc.

[ahus1]

Please note that the build.script reads a snippet from the AsciiDoc file, converts it to HTML and puts in in the plugins XML descriptor.

[rdmueller]

yes, just noticed it and worked on it. Then noticed that it's the same with the CHANGELOG.md :-D

[hediet]

I don't care, as long as it works on github and in the IntelliJ marketplace.

Afaik, vscode extensions are required to have markdown file for the readme, but this does not seem to be the case here.

What is the advantage of asciidoc over markdown? I never saw asciidoc before.

[rdmueller]

Markdown comes in many flavours while there is one standard for AsciiDoc with a wide range of features, like tables, admonitions, includes etc. That is why I think that AsciiDoc is the better choice for technical docs