Skip to content

Commit 363040b

Browse files
yammanhammadyammanhammad
committed
Release v1.1.1: Update version numbers and documentation
- Update version to 1.1.1 in all relevant files - Update installation instructions to prioritize GitHub releases - Add v1.1.1 section to CHANGELOG.md and RELEASE_NOTES.md - Highlight cross-platform package availability - Ensure consistent documentation across all markdown files
1 parent b18a080 commit 363040b

File tree

11 files changed

+264
-87
lines changed

11 files changed

+264
-87
lines changed

‎CHANGELOG.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,29 @@ All notable changes to the Route Planner project will be documented in this file
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
*All Windows executables and cross-platform packages are automatically built and published using GitHub Actions.*
9+
10+
## [1.1.1] - 2025-06-05
11+
12+
### Added
13+
- Cross-platform Python packages (wheel and source distribution) now available for Linux/macOS users
14+
- Direct download links for non-technical users on all platforms
15+
16+
### Fixed
17+
- GitHub Actions workflow now successfully builds and publishes cross-platform packages
18+
- All platform installation instructions updated to reflect available packages
19+
20+
### Changed
21+
- Updated documentation to show cross-platform packages are available (not "coming soon")
22+
- Improved installation guidance for Linux/macOS users
23+
824
## [1.1.0] - 2025-06-05
925

26+
### Added
27+
- GitHub Actions automated build and release pipeline
28+
- Cross-platform Python packages (wheel and source distribution) for Linux/macOS
29+
- Improved installation instructions prioritizing non-technical users
30+
1031
### Changed
1132
- Refactored main entry point structure following Python best practices
1233
- Renamed route_planner/main.py to route_planner/core.py for better organization

‎DEVELOPMENT.md‎

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This guide provides detailed information for developers working on or contributing to the Route Planner project.
44

5+
**🚀 For End Users:** If you just want to use Route Planner, download the pre-built executable from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest) - no development setup needed!
6+
7+
*Note: All Windows executables and cross-platform packages are automatically built and published using GitHub Actions CI/CD.*
8+
59
## Development Environment Setup
610

711
### Prerequisites
@@ -19,13 +23,19 @@ This guide provides detailed information for developers working on or contributi
1923

2024
2. **Set up environment**
2125
```bash
22-
python scripts/setup_env.py
26+
# Create virtual environment
27+
python -m venv .venv
28+
29+
# Activate environment
30+
# On Windows:
31+
.venv\Scripts\activate
32+
# On Linux/macOS:
33+
source .venv/bin/activate
34+
35+
# Install dependencies
36+
pip install -r requirements.txt
37+
pip install -e .
2338
```
24-
This script will:
25-
- Create a virtual environment
26-
- Install dependencies from requirements.txt
27-
- Set up pre-commit hooks
28-
- Configure development settings
2939

3040
3. **Verify setup**
3141
```bash
@@ -37,12 +47,13 @@ This guide provides detailed information for developers working on or contributi
3747

3848
```
3949
Route_Planner/
40-
├── main.py # Application launcher
50+
├── main.py # Application entry point
4151
├── config.py # Configuration settings
4252
├── requirements.txt # Python dependencies
4353
├── route_planner.py # Cross-platform launcher
4454
├── route_planner/ # Main application package
4555
│ ├── __init__.py # Package initialization
56+
│ ├── core.py # Entry point (calls app.py main)
4657
│ ├── app.py # Core application with UI
4758
│ ├── algorithms/ # Routing algorithms
4859
│ ├── ui/ # User interface components
@@ -52,8 +63,6 @@ Route_Planner/
5263
└── cache/ # Runtime cache
5364
```
5465

55-
See subdirectory READMEs for more detailed information about specific components.
56-
5766
## Development Workflow
5867

5968
### Branching Strategy
@@ -103,14 +112,17 @@ Windows executables are built automatically by GitHub Actions CI/CD:
103112
- `scripts/installer.nsi` - NSIS installer script
104113

105114
### Cross-Platform Packages
106-
For other platforms, use the scripts directory tools:
115+
For other platforms, you can build packages using:
107116

108117
```bash
109-
# Set up development environment
110-
python scripts/setup_env.py
118+
# Install build dependencies
119+
pip install build wheel
120+
121+
# Build distribution packages
122+
python -m build
111123

112-
# Install package for distribution
113-
python scripts/install.py
124+
# Install locally for testing
125+
pip install -e .
114126
```
115127

116128
## Documentation

‎README.md‎

Lines changed: 57 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
# 🚚 Route Planner - Delivery Route OptimizFor detailed options and troubleshooting, see the [Windows Guide](docs/WINDOWS_GUIDE.md).
1+
# 🚚 Route Planner - Delivery Route Optimizer
22

3-
### Linux 🐧
4-
```bash
5-
# Clone and install manually
6-
git clone https://github.com/yammanhammad/Route_Planner.git
7-
cd Route_Planner
8-
python scripts/install.py
9-
```
10-
11-
Or use the cross-platform installer from scripts directory.Version](https://img.shields.io/badge/version-1.1.0-blue.svg)
3+
![Version](https://img.shields.io/badge/version-1.1.1-blue.svg)
124
![License](https://img.shields.io/badge/license-MIT-green.svg)
135
![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)
146
![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)
@@ -44,38 +36,72 @@ A sophisticated desktop application for optimizing delivery routes using advance
4436

4537
## 🚀 Quick Start
4638

47-
### Windows
48-
1. **Download** `RoutePlanner-Bundled.zip` from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
49-
2. **Extract** anywhere on your computer
50-
3. **Run** `setup.bat` or `RoutePlanner.exe` directly
39+
Choose the installation method that works best for you. **For non-technical users, we recommend starting with Option 1.**
5140

52-
For detailed options and troubleshooting, see the [Windows Guide](docs/WINDOWS_GUIDE.md).
41+
### Option 1: 🖥️ Pre-built Executables & Packages (Easiest - No Technical Knowledge Required)
5342

54-
### Linux
43+
**Windows:**
44+
1. **Download** the latest release from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
45+
- `RoutePlanner-Bundled.zip` (Recommended - includes all dependencies)
46+
- `RoutePlanner-Setup.exe` (Traditional installer)
47+
2. **Extract** (for zip) or **install** (for exe)
48+
3. **Run** `RoutePlanner.exe`
49+
50+
**Linux/macOS:**
51+
1. **Download** the cross-platform Python package from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
52+
- `route_planner-1.1.1-py3-none-any.whl` (Recommended)
53+
- `route-planner-1.1.1.tar.gz` (Source distribution)
54+
2. **Install**: `pip install route_planner-1.1.1-py3-none-any.whl`
55+
3. **Run**: `route-planner`
56+
57+
✨ *All executables and packages are automatically built and published by our GitHub Actions CI/CD pipeline - no manual compilation needed!*
58+
59+
### Option 2: 📦 Python Package (For Python Users)
60+
61+
**All Platforms:**
5562
```bash
56-
curl -sSL https://raw.githubusercontent.com/yammanhammad/Route_Planner/master/linux/quick-install.sh | bash
63+
pip install route-planner
64+
route-planner
5765
```
5866

59-
For more Linux options, see the [Linux Installation Guide](linux/README.md).
67+
### Option 3: 🔧 From Source (For Developers)
6068

61-
### macOS
69+
**Linux/macOS:**
6270
```bash
63-
# Install Python 3.8+ if needed
64-
brew install python3
65-
66-
# Install Route Planner
67-
pip3 install route-planner
71+
git clone https://github.com/yammanhammad/Route_Planner.git
72+
cd Route_Planner
73+
pip install -r requirements.txt
74+
python main.py
75+
```
6876

69-
# Run the application
70-
route-planner
77+
**Windows:**
78+
```bash
79+
git clone https://github.com/yammanhammad/Route_Planner.git
80+
cd Route_Planner
81+
pip install -r requirements.txt
82+
python main.py
7183
```
7284

73-
### Python (All Platforms)
85+
### Option 4: 🚀 Quick Launcher Scripts
86+
87+
**Linux/macOS:**
7488
```bash
75-
pip install route-planner
76-
route-planner
89+
git clone https://github.com/yammanhammad/Route_Planner.git
90+
cd Route_Planner
91+
chmod +x scripts/run_route_planner.sh
92+
./scripts/run_route_planner.sh
7793
```
7894

95+
**Windows:**
96+
```cmd
97+
git clone https://github.com/yammanhammad/Route_Planner.git
98+
cd Route_Planner
99+
scripts\run_route_planner.bat
100+
```
101+
102+
---
103+
**📖 Need Help?** See our detailed [Windows Guide](docs/WINDOWS_GUIDE.md) for troubleshooting and advanced options.
104+
79105
## 📱 How to Use
80106

81107
1. **Start the application** using your preferred installation method
@@ -119,8 +145,8 @@ For a comprehensive guide with screenshots, see the [User Guide](docs/README.md)
119145
- **Windows Defender warning**: Right-click the exe → "Run as administrator"
120146

121147
**Linux**
122-
- **Missing dependencies**: Run `python scripts/setup_env.py`
123-
- **Environment issues**: Use `python scripts/install.py` for automated setup
148+
- **Missing dependencies**: Run `pip install -r requirements.txt`
149+
- **Environment issues**: Use the shell script `./scripts/run_route_planner.sh` for automated environment setup
124150

125151
**All Platforms**
126152
- **Map not loading**: Check internet connection for initial setup

‎docs/CONTRIBUTING.md‎

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,48 @@
22

33
Thank you for your interest in contributing to Route Planner! This document provides guidelines for contributing to the project.
44

5+
**🚀 Just want to use the app?** Download the pre-built executable from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest) - no development setup required!
6+
7+
*Note: All Windows executables and cross-platform packages are automatically built and published using GitHub Actions CI/CD when releases are created.*
8+
9+
## Getting Started
10+
511
## Getting Started
612

7-
1. Fork the repository
8-
2. Clone your fork locally
13+
### 🚀 Quick Setup (Recommended for Contributors)
14+
```bash
15+
# Clone and setup in one go
16+
git clone https://github.com/yammanhammad/Route_Planner.git
17+
cd Route_Planner
18+
pip install -r requirements.txt
19+
pip install -e . # Install in development mode
20+
python main.py # Test the application
21+
```
22+
23+
### 🔧 Full Development Setup (Advanced)
24+
1. Fork the repository on GitHub
25+
2. Clone your fork locally:
26+
```bash
27+
git clone https://github.com/YOUR_USERNAME/Route_Planner.git
28+
cd Route_Planner
29+
```
930
3. Set up the development environment:
1031
```bash
1132
python scripts/setup_env.py
33+
pip install -e .
34+
```
35+
4. Create a new branch for your feature or bugfix:
36+
```bash
37+
git checkout -b feature/your-feature-name
1238
```
13-
4. Create a new branch for your feature or bugfix
39+
40+
### ✅ Verify Your Setup
41+
```bash
42+
# Test all entry points work
43+
python main.py # Direct execution
44+
route-planner # Installed command
45+
./scripts/run_route_planner.sh # Shell script (Linux/macOS)
46+
```
1447

1548
## Development Guidelines
1649

‎docs/README.md‎

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,38 @@ This directory contains comprehensive documentation for the Route Planner applic
1818

1919
### Getting Started
2020

21-
1. **Launch the Application**
21+
### Getting Started
22+
23+
**Choose the installation method that works best for you:**
24+
25+
1. **🖥️ Pre-built Executables & Packages (Easiest - Recommended for Non-Technical Users)**
26+
27+
**Windows:**
28+
- Download from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
29+
- Choose `RoutePlanner-Bundled.zip` (recommended) or `RoutePlanner-Setup.exe`
30+
- Extract/install and run `RoutePlanner.exe`
31+
32+
**Linux/macOS:**
33+
- Download `route_planner-1.1.1-py3-none-any.whl` from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
34+
- Install: `pip install route_planner-1.1.1-py3-none-any.whl`
35+
- Run: `route-planner`
36+
37+
*✨ All executables and packages are automatically built using GitHub Actions CI/CD - no compilation needed!*
38+
39+
2. **📦 Python Package (For Python Users)**
40+
```bash
41+
pip install route-planner
42+
route-planner
43+
```
44+
45+
3. **🔧 From Source (For Developers)**
46+
- See [Installation Guide](../README.md#-quick-start) for detailed instructions
47+
48+
2. **Launch the Application**
2249
- Windows: Double-click `RoutePlanner.exe`
23-
- Linux: Run `route-planner` from terminal or application menu
24-
- macOS: Run `route-planner` from terminal
50+
- Linux/macOS: Run `route-planner` from terminal or application menu
2551

26-
2. **Add Delivery Stops**
52+
3. **Add Delivery Stops**
2753
- Click the "+ Stop" button
2854
- Enter address or coordinates
2955
- Repeat for all delivery locations

‎docs/RELEASE_NOTES.md‎

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,49 @@
22

33
This document contains all release notes for Route Planner, with the most recent version at the top.
44

5-
## Route Planner v1.0.3 (Latest)
5+
**🚀 Quick Installation:** Download the latest version from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest):
6+
- **Windows**: Choose `RoutePlanner-Bundled.zip` for the easiest installation experience
7+
- **Linux/macOS**: Choose `route_planner-1.1.1-py3-none-any.whl` for easy pip installation
8+
9+
*All Windows executables and cross-platform packages are automatically built and published using GitHub Actions.*
10+
11+
## Route Planner v1.1.1 (Latest)
12+
13+
**Release Date:** June 2025
14+
15+
### 🚀 Cross-Platform Package Release
16+
- **Cross-Platform Packages Available**: Python wheel and source distributions now available for Linux/macOS
17+
- **GitHub Actions Build**: All packages (Windows executables + cross-platform Python packages) automatically built via CI/CD
18+
- **Easy Installation**: Non-technical users can now easily install on any platform using pre-built packages
19+
20+
### 📦 Installation Options
21+
- **Windows**: Download executable packages (`RoutePlanner-Bundled.zip` or `RoutePlanner-Setup.exe`)
22+
- **Linux/macOS**: Download Python wheel (`route_planner-1.1.1-py3-none-any.whl`) and install with pip
23+
- **All Platforms**: Standard PyPI installation (`pip install route-planner`) also available
24+
25+
## Route Planner v1.1.0
26+
27+
**Release Date:** December 2024
28+
29+
### 🧹 Major Cleanup & Modernization
30+
- **Removed Obsolete Scripts**: Cleaned up manual build scripts and unnecessary files
31+
- **Streamlined Entry Points**: Single main.py entry point with refactored code structure
32+
- **Updated Documentation**: Comprehensive update of all installation guides and documentation
33+
- **Removed Legacy Directories**: Eliminated linux/ and tests/ directories
34+
- **Version Consistency**: Updated all version references to v1.1.0
35+
36+
### 🚀 Installation Improvements
37+
- **Cross-Platform Packages**: Now available for Linux/macOS via GitHub Actions builds
38+
- **Simplified Instructions**: Installation guides now start with easiest methods for non-technical users
39+
- **Better Organization**: Clear prioritization of pre-built packages → Python package → source installation
40+
- **GitHub Actions Integration**: All Windows executables and cross-platform packages built automatically via CI/CD
41+
42+
### 🔧 Development Enhancements
43+
- **Code Refactoring**: Moved route_planner/main.py to route_planner/core.py for better organization
44+
- **Build Process**: Fixed YAML syntax in GitHub Actions workflow
45+
- **Entry Point Consistency**: Updated all references to use new code structure
46+
47+
## Route Planner v1.0.3
648

749
**Release Date:** May 15, 2025
850

@@ -85,8 +127,8 @@ This document contains all release notes for Route Planner, with the most recent
85127

86128
#### Option 1: Quick Start (Recommended)
87129
Download the platform-specific archive for your operating system, extract it, and run:
88-
- Windows: `install.py` or `run_route_planner.bat`
89-
- macOS/Linux: `./install.py` or `./run_route_planner.sh`
130+
- Windows: `run_route_planner.bat` or download executable from releases
131+
- macOS/Linux: `./scripts/run_route_planner.sh` or use pip install
90132

91133
#### Option 2: Python Package (All Platforms)
92134
```bash

0 commit comments

Comments
 (0)