# Installation

UrConnect is distributed through GitHub Releases and as source code. The desktop application is written in C++ with Qt 5, CMake, Boost headers, OpenGL, and bundled Shapelib sources.

## Supported Platforms

Windows is the primary v0.1.0 release target. macOS and Linux packages are provided as experimental builds while cross-platform validation continues.

## Install From A Release

Download the package for your operating system from the GitHub Releases page:

- Windows: `UrConnect-v0.1.0-windows-x64.zip`
- macOS experimental: `UrConnect-v0.1.0-macos-arm64-experimental.tar.gz`
- Linux experimental: `UrConnect-v0.1.0-linux-x64-experimental.tar.gz`

Unpack the archive and run the `UrConnect` executable or application bundle.

## Build From Source

Install:

- CMake 3.13 or newer
- A C++11 compiler
- Qt 5.15 with Core, Gui, Widgets, and OpenGL modules
- Boost headers
- OpenGL and GLU development libraries

### Windows

```powershell
cmake -S . -B build -G "Visual Studio 17 2022" -A x64 `
  -DQT5_ROOT="C:/Qt/5.15.2/msvc2019_64" `
  -DBOOST_ROOT="C:/local/boost_1_83_0"
cmake --build build --config Release
```

The executable is generated under `build/bin/Release/`.

### macOS

With Homebrew:

```bash
brew install cmake qt@5 boost
cmake -S . -B build \
  -DQT5_ROOT="$(brew --prefix qt@5)" \
  -DBOOST_ROOT="$(brew --prefix boost)"
cmake --build build --config Release -j 4
```

### Linux

On Ubuntu:

```bash
sudo apt-get update
sudo apt-get install -y build-essential cmake qtbase5-dev libqt5opengl5-dev \
  libboost-all-dev libgl1-mesa-dev libglu1-mesa-dev
cmake -S . -B build -DBOOST_ROOT=/usr/include
cmake --build build --config Release -j 4
```

## Build Notes

- The input network must be a segment model prepared in GIS or another drawing tool.
- UrConnect does not provide geometry editing tools.
- Shapefile outputs are written back to the opened source file.
- CSV/TXT inputs are backed by a generated Shapefile output for GIS compatibility.