search

lcodeca / SUMOActivityGen

An Activity-based Multi-modal Mobility Scenario Generator for SUMO. This project is available in the Eclipse SUMO contributed tools section (https://github.com/eclipse/sumo/tree/master/tools/contributed) under the name SAGA (SUMO Activity GenerAtion).
Eclipse Public License 2.0
40 stars 25 forks source link

Improving documentation. #20

Closed lcodeca closed 4 years ago

abrac commented 4 years ago

Hi Lara, one of the first things that confused me when I first read the documentation was that there was no direction as to which file I should start reading first. I'm assuming HOWTO.md is supposed to act as a table of contents / index?

If that is the case, I have two recommendations:

  1. perhaps HOWTO.md should be renamed to something like "index.md" and linked to in Readme.md (L21).
  2. perhaps the optional parameters section should be removed in HOWTO.md (L23-L47) as it is duplicated in ScenarioGenerator.md

I am making these changes to my fork and will make a pull request shortly to let you know what I mean.