No clear installation/setup guidelines

[mabl3]

From the start page of the repository, there is no apparent description or guideline for new users on how to setup and run the ADIT software.

Usually, in other projects, there are sections mentioning the hard- and software requirements and the necessary steps to get the software to run. Or there are links to wikis or documentations where these things are described.

There are some commands listet in CONTRIBUTING.md, though
a) this is not the ideal place imo (I usually need to gain experience working with something before I start thinking about contributing to the development)
b) there is still a lack of explanations and no explicit listing of requirements, so it's unclear how to deal with errors or deployment failures

Also, the link under the section api-client is broken.

tl;dr: Adding a few quickstart guidelines would greatly improve experience for new users.

Thanks to the team for your work so far!

[medihack]

Hi @mabl3, thank you for your interest in ADIT!
Although we have been developing the application in a public setting, ADIT has primarily served as an internal tool for the past several years at two university hospitals. We have not made any public announcements about it yet. Our plan is to officially announce it and release comprehensive documentation on a dedicated website by the end of February. The same applies to our other application, RADIS (maybe a bit later).

[mabl3]

Thanks for your reply! I'm looking forward then for the official release :)