Create readme file

Prepare a readme file for the repository that:

• Tells what the package is and specifies that it's designed to be flexible and interface with Kwant.
• Explain installation.
• Show basic usage.
• Explain how to cite us.

added 4 commits

• e9d1adf2...bcece409 - 2 commits from branch main
• c89344d2 - Merge branch 'main' into readme
• 361f531a - draft README

Compare with previous version

added 68 commits

• 361f531a...275d1bf3 - 67 commits from branch main
• 92fa4df5 - Merge branch 'main' into readme

Compare with previous version

added 1 commit

• 30a8e352 - remove line saying it's WIP

Compare with previous version

added 1 commit

• 49c1bb7b - Remove "simple" from description.

Compare with previous version

added 1 commit

• 476abf8c - Remove "dictionary".

Compare with previous version

added 1 commit

• d5d899f3 - include readme as index

Compare with previous version

added 2 commits

• b349fd58 - add license
• 6da8c3fd - touch up cite section

Compare with previous version

added 1 commit

• 3878080c - add authors

Compare with previous version

added 1 commit

• 44214c47 - forgot bibtex part

Compare with previous version

added 3 commits

• c43b7acb - update contributors
• 93635f53 - update license
• 2bb65575 - adjust authors

Compare with previous version

added 1 commit

• e93433d2 - apply Antonios suggestion

Compare with previous version

resolved all threads