a-b-street / a-b-street/abstreet

Adding more README's for the subdirectories

未关闭
#1,048 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Rust
星标
8.2k
派生
380
PR 合并指标
30 天内没有已合并 PR

描述

I am a beginner Rust programmer and wanted to try and contribute code to AB-street

However, I am very confused on the role of each subdirectory and how I can begin to understand the functionality of each component of AB-street

This Is very likely mainly due to my inexperience with the software and more importantly the language itself. However, it would be nice to have some sort of guidelines on what is happening in each subdirectory.

Currently these are the directories that already have READMEs
image

Tasklist for remaining crates:
- [ ] abstio
- [ ] cloud
- [x] geom
- [ ] map_gui
- [ ] raw_map
- [ ] target
- [ ] updater
- [ ] abstutil
- [ ] collisions
- [ ] headless
- [ ] map_model
- [ ] release
- [ ] tests
- [x] web
- [x] apps
- [ ] convert_osm
- [ ] importer
- [x] piggyback
- [ ] sim
- [ ] traffic_seitan
- [x] widgetry
- [ ] cli
- [x] data
- [ ] kml
- [ ] popdat
- [ ] synthpop
- [ ] traffic_signal_data
- [ ] widgetry_demo
- [ ] update the corresponding docs [section](https://a-b-street.github.io/docs/tech/dev/index.html#code-organization)

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。