Problem
The repository has no README.md at all. New contributors or reviewers have no way to understand what this project does, how to install dependencies, or how to run it.
Requested Changes
- Add a top-level
README.md with:
- Project description: autonomous coal-mine truck fleet simulation using Pygame, MPC controller, A* pathfinding, Kalman filtering, and a global optimizer
- Architecture diagram (ASCII or Mermaid) showing the two modules:
MAP/ (map editor + algorithm) and Simulation/ (simulation engine)
- Prerequisites: Python 3.x, pygame, numpy, scipy (for MPC), etc.
- Step-by-step setup and run instructions for both the Map Editor (
MAP/Map_Editor.py) and the Simulation (Simulation/main.py)
- Brief description of each major file:
main.py, car.py, dispatcher.py, mpc_controller.py, GlobalOptimizer.py, graph_adapter.py
- Configuration guide for
mine_config.json (truck_count, coal_capacities) and config.py constants
- Known limitations / future work section
Problem
The repository has no README.md at all. New contributors or reviewers have no way to understand what this project does, how to install dependencies, or how to run it.
Requested Changes
README.mdwith:MAP/(map editor + algorithm) andSimulation/(simulation engine)MAP/Map_Editor.py) and the Simulation (Simulation/main.py)main.py,car.py,dispatcher.py,mpc_controller.py,GlobalOptimizer.py,graph_adapter.pymine_config.json(truck_count, coal_capacities) andconfig.pyconstants