Feature/update readme

[formatc1702]

I've restructured the main README file, added and moved around some of the information. I welcome any new input to make the readme more user-friendly.

[formatc1702]

A better description for the build_examples.py options is probably a good thing to add.

[formatc1702]

Please make sure this workflow makes sense.

[kvid]

Should you also mention something like the alternative variant you gave to me in #43 (comment)?

git clone https://github.com/formatc1702/WireViz.git
cd WireViz/
python -m venv wv-env
source wv-env/bin/activate
pip3 install -e .
cd src/wireviz
python build_examples.py

Note that git checkout dev is missing above, and I have not tried any of these installations from scratch recently.

[kvid]

Should there be a link to CONTRIBUTING.md near the end of the section about Installing the development version?

[formatc1702]

Sorry, didn't see these comments earlier.

• I'm not sure whether we should give advice on virtual environments directly, or reference a site that explains the concept more generally.
• Sure, I can include a link to CONTRIBUTING.md

[kvid]

A better description for the build_examples.py options is probably a good thing to add.

See PR #118 description for a short summary in the Usage section, and a couple of use cases in the last section, to get some ideas.

[formatc1702]

It might make sense to create a docs/ directory or similar, for the changelog, the syntax description, and the build_examples.py documentation. This way we don't overload the readme, or the parent directory.
In the future, this can be replaced by a properly built documentation system.

[formatc1702]

I'm merging this into feature/syntax-description since they are closely related; let's continue the discussion in #111.