docs: update README

[RafaelAPB]

The current README presents potentially outdated information that holds details that are better suitable for the whitepaper. It lacks instructions on how to build and run the project, which can frustrate newcomers.

I would propose us to simplify the README of the project, and as the example section matures, provide a practical example.

[RafaelAPB]

We can add an updated version of the architecture, and forward readers to the whitepaper, as well

[petermetz]

LGTM

[petermetz]

@RafaelAPB Would be nice to have a more specific commit message. Update README can mean a lot of different things. I'd say something like docs(readme): reference build instructions for example.

[RafaelAPB]

I've chosen that specific message because the commit also removes parts of it. Would it still be reasonable to only refer the build instructions?

[petermetz]

I've chosen that specific message because the commit also removes parts of it. Would it still be reasonable to only refer the build instructions?

Tough question. It definitely makes sense IMO to not just say updated readme, but how much explanation should fit in the commit subject line (the top line) is difficult to say.
My personal take: I'd use the commit body (e.g. lines after the first) to explain the rest of the story like that the theoretic explanations have been removed in favor of the rest of the documentation which contains the same information.
Something like that. :-)

[RafaelAPB]

Makes sense. Let's see first what the other reviewers think.

Sorry, I mistook to choose review comment.

[takeutak]

I have strengthened your proposal as the commit below. The reason is written in the header of the commit below. Do you have any comments?
3bfab32

[RafaelAPB]

I agree, @takeutak ! Thanks!

[petermetz]

CI is failing because of an unrelated problem: #319

[takeutak]

LGTM

[jonathan-m-hamilton]

LGTM, pending CI resolution

[RafaelAPB]

Done @petermetz , thanks!

[takeutak]

Excuse me, it look like that the current README ignores my suggestion (due to the mistake on solving CI falling?)
3bfab32
Please wait for merging before solving the issue.

[takeutak]

As I said the above, the current status ignores my above commit. Then I canceled my LGTM at once.

[takeutak]

I pushed the following commit, which content is the same as the above my commit.
ab2542d

Now I approved this PR again.

[takeutak]

LGTM