Update README

[HeleNoir]

We should update our README (not necessarily all at once, but all before making MAHF public):

• the examples are not up to date
• I think we don't need the Papers this is based upon section anymore as we are quite far from these ideas now
• a short explanation of how to use MAHF in general is necessary (even though once the documentation is finished, the info is there, but we want some overview in the README, too)
• we should explain the use of param-study and paramils (if it still works)
• we should provide a short section of things to come

[HeleNoir]

Oh, and I don't know if we want to do part of this together with #108 or #96 .

[luleyleo]

I agree with the points you've mentioned. Given that it fits perfectly into #108 I'll take care of it.

[Saethox]

Should we move param-study (and paramils) into its own repository? We don't have an organization yet, but I think it would work better as an external repo in our organization, than a folder in the main repo. For now, it could be another private repo, as transferring to an organization seems to be pretty straightforward.

I remember we wanted to do this for evaluation anyway.

[luleyleo]

Yes, I think it would make sense to move parameter optimization into its own repo. But making it, or at least examples and utilities for it public would be good nevertheless.

[HeleNoir]

I'm still thinking about how to structure everything. evaluation will go seperately in any case, and param-study would make sense, too. I'm also thinking about another repository for all experiments that will be performed (and hopefully published), though we might integrate this into evaluation. But we can discuss this in the near future.

[Saethox]

I think the README could also use some code examples, e.g., to demonstrate that our ConfigurationBuilder is pretty close to pseudocode.

Also, a short section on how to add the mahf to Cargo.toml would be appropriate.

[luleyleo]

I agree that a code example would be nice, but they have a strong tendency to become out of date. Maybe create an issue for it now, and add one once it's less likely to change?

I'm not sure about the latter. All you need to do once mahf is published is cargo add mahf. But I was considering writing a small guide for users without Rust experience, which could contain such information.

[HeleNoir]

Maybe create an issue for it now, and add one once it's less likely to change?

That sounds good. As much as I would like an example, too, I also think it might be too soon.

But I was considering writing a small guide for users without Rust experience, which could contain such information.

That would be really nice. Especially as I assume there are not many people who are interested in MAHF and proficient in Rust at the same time.

[luleyleo]

Closed by #108