first pass at README review from fresh eyes #1
Conversation
|
Also add a repo url preview for social shares: |
| @@ -1,7 +1,21 @@ | |||
| # Poietic Flows | |||
|
|
|||
| Systems Dynamics Modelling and simulation toolkit based on the | |||
| [Stock and Flow](https://en.wikipedia.org/wiki/Stock_and_flow) methodology. | |||
| [Stock and Flow](https://en.wikipedia.org/wiki/Stock_and_flow) methodology . | |||
There was a problem hiding this comment.
Describing what this repo does with a link to the wikipedia description is a really nice start. I read so many repos and have to get deep into the README before I even have an idea about the problem it is trying to solve.
That said, you have 3 links to the same wikipedia article in the README
There was a problem hiding this comment.
Thanks for pointing that out. Happened by just copy-pasting snippets from other notes/docs. Will correct that.
| @@ -1,7 +1,21 @@ | |||
| # Poietic Flows | |||
|
|
|||
| Systems Dynamics Modelling and simulation toolkit based on the | |||
| [Stock and Flow](https://en.wikipedia.org/wiki/Stock_and_flow) methodology. | |||
| [Stock and Flow](https://en.wikipedia.org/wiki/Stock_and_flow) methodology . | |||
There was a problem hiding this comment.
Thanks for pointing that out. Happened by just copy-pasting snippets from other notes/docs. Will correct that.
| ## Who it's for | ||
|
|
||
| I wrote this when solving problem ???. It would be applicable to economists, and X and X. | ||
|
|
There was a problem hiding this comment.
The software is not yet ready for the intended target audience. For now, it is just "for the curious". I'll write a longer post about the larger vision, including the problems I am trying to address in the domain of SD modelling, once I wrap-up the preview.
| @@ -35,6 +49,8 @@ Planned: | |||
|
|
|||
| ## Installation | |||
|
|
|||
| Poietec runs on Mac OS X, ?? and ??. | |||
There was a problem hiding this comment.
Good point. Will note that. Had to do some fixes to make it work again on Linux (there are some methods that are deprecated on MacOS yet not available on Linux).
No description provided.