Skip to content

Add README.md with project overview, setup, and architecture docs #1

@Rishik-Y

Description

@Rishik-Y

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions