README.md

Route Planner Documentation

This directory contains comprehensive documentation for the Route Planner application.

User Documentation

• User Guide
• Windows Guide - Installation, troubleshooting, and compatibility for Windows users
• Release Notes - Version history and feature updates
• Contributing - Guidelines for contributors

Quick Links

• Installation Guide
• Development Guide - For developers and contributors

User Guide

Getting Started

Choose the installation method that works best for you:

1. 🖥️ Pre-built Executables & Packages (Easiest - Recommended for Non-Technical Users)

   Windows:

   • Download from GitHub Releases
   • Choose RoutePlanner-Bundled.zip (recommended) or RoutePlanner-Setup.exe
   • Extract/install and run RoutePlanner.exe

   Linux/macOS:

   • Download route_planner-[VERSION]-py3-none-any.whl from GitHub Releases
   • Create a virtual environment (recommended):

     python3 -m venv route-planner-env
     source route-planner-env/bin/activate

   • Install: pip install route_planner-[VERSION]-py3-none-any.whl
   • Run: route-planner

   ✨ All executables and packages are automatically built using GitHub Actions CI/CD - no compilation needed!

2. 📦 Python Package (For Python Users)

   pip install route-planner
   route-planner

3. 🔧 From Source (For Developers)

   • See Installation Guide for detailed instructions

4. Launch the Application

   • Windows: Double-click RoutePlanner.exe
   • Linux/macOS: Run route-planner from terminal or application menu

5. Add Delivery Stops

   • Click the "+ Stop" button
   • Enter address or coordinates
   • Repeat for all delivery locations

6. Configure Route Settings

   • Select algorithm (Auto, Held-Karp, or Christofides)
   • Set additional options like traffic conditions
   • Choose map style

7. Calculate Route

   • Click "Plan Route" button
   • Wait for algorithm to complete
   • Review the optimized route

8. Use the Route

   • Follow numbered stops in sequence
   • View turn-by-turn directions
   • Export route to GPS or PDF

Interface Guide

• Map Area: Central display showing stops and route
• Sidebar: Controls for adding stops and settings
• Bottom Panel: Algorithm performance and statistics
• Top Bar: Quick actions and application controls

Advanced Features

• Offline Mode: Use Route Planner without internet
• Custom Algorithms: Adjust optimization parameters
• Data Import/Export: CSV, JSON, and GPX support
• Route Comparison: Compare different algorithms

Technical Documentation

For technical documentation, including architecture details, API references, and development guidelines, see DEVELOPMENT.md.