Add comprehensive build documentation and verification script for master branch
This PR addresses the need for comprehensive, up-to-date build instructions for the HPCC Platform master branch by providing modern documentation that consolidates information from various sources and addresses common developer workflows.
Problem Statement
The existing BUILD_ME.md contained basic build instructions but lacked:
- Modern vcpkg-based dependency management guidance
- Clear time expectations for first-time builds
- Comprehensive troubleshooting for common issues
- Platform-specific optimization recommendations
- Automated verification of build environment setup
Solution
New Comprehensive Build Guide (BUILD_MASTER_GUIDE.md)
A complete 463-line build guide that includes:
- Quick Start Options: Both automated verification script and manual configuration paths
- Prerequisites: Detailed installation instructions for Ubuntu, CentOS, macOS, and Windows
- Modern Build Process: Explains vcpkg integration and dependency management
- Build Time Expectations: Clear guidance on build times (15-90 minutes depending on configuration)
- Multiple Configurations: Development, release, client-tools-only, and containerized builds
- Comprehensive Troubleshooting: Common issues including vcpkg timeouts and dependency problems
- Development Workflows: VS Code integration, testing, and debugging guidance
Automated Verification Script (verify-build-setup.sh)
A 152-line bash script that:
- Checks all build prerequisites (CMake, Ninja, Git, compilers)
- Validates source directory structure and submodules
- Tests CMake configuration with realistic build options
- Performs a test compilation to verify the complete toolchain
- Provides clear success/failure feedback and actionable next steps
Enhanced Legacy Documentation
Updated BUILD_ME.md to:
- Reference the new comprehensive guide prominently at the top
- Preserve existing legacy instructions for compatibility
- Guide new developers toward modern workflows
Key Technical Insights
The documentation addresses several important aspects of the modern HPCC Platform build:
- vcpkg Integration: The build system now uses vcpkg for cross-platform dependency management, which requires 15-45 minutes for first-time setup but handles dependencies automatically
- Build Configurations: Multiple optimized configurations support different development scenarios
- Time Management: First-time builds can take 15-90 minutes depending on configuration, with subsequent builds much faster
- Platform Variations: Each platform has specific considerations and optimizations
Usage Examples
Quick automated verification:
git clone --recurse-submodules https://github.com/hpcc-systems/HPCC-Platform.git
cd HPCC-Platform
./verify-build-setup.sh
Manual development build:
mkdir build && cd build
cmake -B . -S .. -G Ninja -DUSE_CPPUNIT=ON -DINCLUDE_PLUGINS=ON -DCMAKE_BUILD_TYPE=Debug
cmake --build . --parallel
This comprehensive documentation provides both novice and experienced developers with clear, tested instructions for building HPCC Platform from the master branch, addressing the original request with modern, maintainable guidance.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.