Skip to content

Commit 7b66639

Browse files
committed
docs: add install instructions, per-OS build guides, and release badge
1 parent 344baad commit 7b66639

File tree

1 file changed

+51
-9
lines changed

1 file changed

+51
-9
lines changed

README.md

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MAVSim Viewer
22

3+
[![Release](https://img.shields.io/github/v/release/mavlink/mavsim-viewer)](https://github.com/mavlink/mavsim-viewer/releases/latest)
4+
35
Lightweight 3D viewer for MAVLink-based flight simulators. Receives `HIL_STATE_QUATERNION` messages over UDP and renders the vehicle with real-time telemetry.
46

57
Built with [Raylib](https://www.raylib.com/) and [MAVLink](https://mavlink.io/).
@@ -19,22 +21,62 @@ Built with [Raylib](https://www.raylib.com/) and [MAVLink](https://mavlink.io/).
1921
- **ULog replay** — play back PX4 `.ulg` flight logs with transport controls and interpolation
2022
- Cross-platform: macOS, Linux, and Windows supported out of the box thanks to Raylib
2123

22-
## Requirements
24+
## Install
25+
26+
### macOS (Homebrew)
27+
28+
```bash
29+
brew tap mavlink/tap
30+
brew install mavlink/tap/mavsim-viewer
31+
```
32+
33+
### Linux (Debian/Ubuntu)
34+
35+
Download the `.deb` from the [latest release](https://github.com/mavlink/mavsim-viewer/releases/latest):
36+
37+
```bash
38+
sudo dpkg -i mavsim-viewer-*.deb
39+
```
40+
41+
### From source
2342

24-
- CMake 3.14+
25-
- C compiler (GCC, Clang, MSVC)
26-
- Git (for submodules and Raylib fetch)
43+
#### macOS
2744

28-
## Building
45+
```bash
46+
# Install build tools
47+
brew install cmake git
48+
49+
git clone --recursive https://github.com/mavlink/mavsim-viewer.git
50+
cd mavsim-viewer
51+
cmake -B build -DCMAKE_BUILD_TYPE=Release
52+
cmake --build build
53+
```
54+
55+
#### Linux (Debian/Ubuntu)
2956

3057
```bash
31-
git clone --recursive git@github.com:mavlink/mavsim-viewer.git
58+
# Install build tools and display server dependencies
59+
sudo apt-get install -y cmake git build-essential \
60+
libgl1-mesa-dev libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev
61+
62+
git clone --recursive https://github.com/mavlink/mavsim-viewer.git
3263
cd mavsim-viewer
33-
mkdir build && cd build
34-
cmake ..
35-
make -j$(nproc)
64+
cmake -B build -DCMAKE_BUILD_TYPE=Release
65+
cmake --build build
3666
```
3767

68+
#### Windows
69+
70+
```powershell
71+
# Requires Visual Studio with C/C++ workload, CMake, and Git
72+
git clone --recursive https://github.com/mavlink/mavsim-viewer.git
73+
cd mavsim-viewer
74+
cmake -B build
75+
cmake --build build --config Release
76+
```
77+
78+
The binary will be at `build/Release/mavsim-viewer.exe`.
79+
3880
## Usage
3981

4082
```bash

0 commit comments

Comments
 (0)