# Installation Guide

This document describes PoSDK installation requirements and procedures.


---

## Quick Start

```{tip}
**Quick Installation:**

```bash
git clone https://github.com/pose-only-vision/PoSDK.git
cd PoSDK
./install.sh
```

For all prompts during installation, press Enter to use default values.

```

---

## Installation Guide Navigation

### 1. [Complete Installation Guide](installation.md)

Complete PoSDK installation workflow documentation, including:
- System requirements and dependency checks
- One-click installation script usage instructions
- Detailed manual installation steps
- Dependency installation order and skip strategies
- Detailed installation prompt explanations
- Troubleshooting and common issues

**Complete PoSDK installation guide:**
- System requirements and dependency checks
- One-click installation script usage
- Manual installation steps
- Dependency installation order and skip strategies
- Detailed installation prompt explanations
- Troubleshooting and FAQ

### 2. [Using Precompiled Libraries](using_precompiled.md)

How to use precompiled po_core core library in your project:
- Core library structure description
- CMake integration methods (integrated mode vs non-integrated mode)
- Basic usage examples
- Runtime library lookup troubleshooting

**How to use precompiled po_core libraries:**
- Core library structure
- CMake integration methods
- Basic usage examples
- Runtime library troubleshooting

### 3. [Build Environment and Version Information](po_core_build_environment.md)

po_core core library build environment configuration and dependency version requirements:
- Supported build platforms (Ubuntu 24.04/18.04, macOS)
- Build tool version requirements (GCC, Clang, CMake)
- Dependency library version information (Boost, Ceres, OpenCV, etc.)

**po_core build environment and dependency versions:**
- Supported platforms
- Build tool requirements
- Dependency version information

---

## Installation Overview

```text
┌─────────────────────────────────────────────────────────┐
│  Phase 1: System Dependencies                           │
│  └─ ./install.sh (automatically install system packages)│
└─────────────────────────────────────────────────────────┘
                          ↓
┌─────────────────────────────────────────────────────────┐
│  Phase 2: Build Dependencies                            │
│  └─ ./dependencies/install_dependencies.sh              │
│     (download and build 13 dependency libraries)         │
└─────────────────────────────────────────────────────────┘
                          ↓
┌─────────────────────────────────────────────────────────┐
│  Phase 3: Build PoSDK                                    │
│  └─ cmake .. && make -j$(nproc)                         │
└─────────────────────────────────────────────────────────┘
```

For detailed instructions, please refer to [Complete Installation Guide](installation.md).

---

## Recommended Reading Order

**First-time Installation Users**:
1. [Complete Installation Guide](installation.md) - Understand system requirements and installation process
2. If encountering network issues → [Using Precompiled Libraries](using_precompiled.md)
3. If needing dependency version information → [Build Environment and Version Information](po_core_build_environment.md)

**Experienced Users**:
- Run `./install.sh` directly, refer to relevant documentation when encountering issues

---

## Quick Links to Common Issues

- [Qt Version Conflicts on macOS](installation.md#1-qt-version-conflicts-on-macos)
- [Dependency Installation Failures](installation.md#2-dependency-library-installation-failures)
- [CMake Version Too Low](installation.md#3-cmake-version-too-low)
- [Network Download Failures](installation.md#4-network-issues-causing-dependency-download-failures)

---

## Document List

```{toctree}
:maxdepth: 2

installation
using_precompiled
po_core_build_environment
```

---

Documentation is continuously updated. For questions or issues, please submit feedback at [GitHub Issues](https://github.com/pose-only-vision/PoSDK/issues).