Complete README about tulipaenergymodel.jl HOT 3 CLOSED

It looks like Diego has created a file called "how-to-use.md" with some of this information.
Ah wait that's in the Docs - anyway it can be re-used for the readme if we want.

from tulipaenergymodel.jl.

Correct! It is for the documentation; we might want to have only one file with this information, so we need to update it in one file in case of changes. Then, we just need to reference the file with the information in the markdown files. @abelsiqueira What do you think? any best practice here?

from tulipaenergymodel.jl.

I suggest having a small README with the bare information (the list I have above). It should be around 50 lines at most, I imagine. In the README you link to the places with more detailed information. For instance, you can say add to the README something like

Example:

data = read("input.esdl")
model = create_model(data)
solution = solve_model(model)

For more information check the [tutorial](link to tutorial page on documentation).

The snippet is short enough to be useful for people who know what they're doing. Other users can check the tutorial for more info.

from tulipaenergymodel.jl.