worlddynamics / Vensim2MTK.jl

A Julia package to import Vensim .xmile files as ModelingToolkit.jl models.
MIT License
2 stars 1 forks source link

Improve README #18

Closed natema closed 1 year ago

natema commented 1 year ago

Few suggestions. The itemize https://github.com/worlddynamics/Vensim2MTK.jl#examples-of-models-used is broken. For links you can use the Markdown syntax [the previous link](https://github.com/worlddynamics/Vensim2MTK.jl) which displays as the previous link.

natema commented 1 year ago

Also Usage of the function: Vensim2MTK has 3 arguments: -> The function takes 3 arguments:.

meyde commented 1 year ago

done. Any other instructions on the README?

natema commented 1 year ago

Please improve the writing, e.g. in the new section https://github.com/worlddynamics/Vensim2MTK.jl#examples-of-models-used :

meyde commented 1 year ago

done it.

natema commented 1 year ago
meyde commented 1 year ago

done. I also added a warning about the initialisation issue at the end