Organize crates - Githubissues

a-b-street / abstreet

Transportation planning and traffic simulation software for creating cities friendlier to walking, biking, and public transit

https://a-b-street.github.io/docs/

Apache License 2.0

7.77k stars 346 forks source link

Organize crates #844

Open dabreegster opened 2 years ago

dabreegster commented 2 years ago

We have lots of them now, and the flattened directory listing is a little overwhelming? Here's a vague attempt at organizing, not happy with it yet.

apps

fifteen_min
game
ltn
map_editor
osm_viewer
parking_mapper
santa

project / logistic

cloud
release
tests
traffic_seitan
web

importing

importer
collisions
convert_osm
kml
traffic_signal_data
popdat

map_gui
piggyback
widgetry
widgetry_demo

uncategorized

abstio
abstutil
cli
geom
headless
map_model
sim
updater

dabreegster commented 2 years ago

https://matklad.github.io/2021/08/22/large-rust-workspaces.html - "Flat Is Better Than Nested"

apps/ was an obvious one, but not sure this is worth doing further. Grouping map model things -- maybe? Where's the line between map and sim? (Possibly synthpop). Do the importing tools belong in one or another?

Robinlovelace commented 2 years ago

Good shout to organise them but, without this being an informed opinion, wondering if it's more important to communicate the structure in the docs than in the organisation of the repo?

dabreegster commented 2 years ago

Yeah, updating https://a-b-street.github.io/docs/tech/dev/index.html#code-organization would be useful. I guess the dust has settled here enough for that now