Rewrite README

[rouille]

Pull Request doc

Purpose

Move sections of README in ReST files located in a new docs folder and rewrite README.

What the code is doing

There is no code

Testing

I have checked that the content of the powersimdata/docs folder is properly display in our docs. To reproduce, checkout this branch and the ben/powersimdata branch in the docs repo and run tox there to make sure that the PowerSimData tutorial displays correctly

Where to look

The content of the ReST files is almost identical to the sections in the current README. The only changes I made are:

• change code snippet to use refactor: improve usability of Scenario object #420
• rearrange subsections in the scenario framework section to have create --> execute --> analyze --> delete --> move

The new README is the file that requires attention

Time estimate

Hard to say

[rouille]

Do not hesitate to propose improvements for the README, e.g., more or different bullet points in the Main Features section of the README, etc.

[kasparm]

Looks good @rouille. I like the the tutorial. I created the docs and it displays correctly.
Out of scope: Diagram for software packages and how they interact.

[rouille]

Looks good @rouille. I like the the tutorial. I created the docs and it displays correctly.
Out of scope: Diagram for software packages and how they interact.

We might want to use mermaid for that

[BainanXia]

Looks good @rouille. I like the the tutorial. I created the docs and it displays correctly.
Out of scope: Diagram for software packages and how they interact.

We might want to use mermaid for that

Diagrams can be generated automatically? This is fancy!

[danielolsen]

Is ReST better than markdown? Should we write new READMEs in ReST?

[rouille]

Is ReST better than markdown? Should we write new READMEs in ReST?

ReST is the default plaintext markup language used by Sphinx. So far we have used a plugin to display Markdown file in order to link our package's README. Since, we want i) to have concise README and ii) take full advantage of the more elaborate ReST language, I have translated all the Markdown files to ReST