search

MengeCrowdSim / Menge

The source code for the Menge crowd simulation framework
Apache License 2.0
139 stars 64 forks source link

Examples: coverage and documentation #107

Open MengeCrowdSim opened 5 years ago

MengeCrowdSim commented 5 years ago

As pointed out in #106 the examples need more. Specifically:

  1. We need to make sure there is an example that illustrates every element (for example, currently the "offset" goal selector is not exercised in the examples).
  2. We need to make sure that all examples are documented so that they can more easily be trolled for particular features.
    • to this end, links in the elements that they exercise would be good.
    • A single markdown page that presents a table of contents
  3. Consider re-organizing the examples so that they are organized by what they show off.