Skip to content

Commit 6c6b1d3

Browse files
committed
docs: update README and mainpage with additional badges, installation instructions, and links to documentation
- Added badges for documentation and code coverage to README.md. - Enhanced mainpage.md with installation instructions, prerequisites, and usage examples. - Included links to detailed documentation sections for architecture and examples. Signed-off-by: Y.Hisaki <yhisaki31@gmail.com>
1 parent 1ce1511 commit 6c6b1d3

File tree

2 files changed

+65
-12
lines changed

2 files changed

+65
-12
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
<p><strong>Interactive Data Visualization for Modern C++</strong></p>
44

55
![Build Status](https://img.shields.io/github/actions/workflow/status/yhisaki/plotly.cpp/ci.yml?branch=main)
6+
[![Documentation](https://img.shields.io/badge/docs-Doxygen-blue.svg)](https://yhisaki.github.io/plotly.cpp/)
7+
[![codecov](https://codecov.io/gh/yhisaki/plotly.cpp/graph/badge.svg?token=NsLJgwCpau)](https://codecov.io/gh/yhisaki/plotly.cpp)
68
![Version](https://img.shields.io/github/v/tag/yhisaki/plotly.cpp?label=version)
79
![License](https://img.shields.io/github/license/yhisaki/plotly.cpp)
810
![C++ Standard](https://img.shields.io/badge/C%2B%2B-17%2B-blue.svg)
@@ -17,6 +19,7 @@
1719

1820
> [!WARNING]
1921
> **This library is currently under active development**
22+
>
2023
> We welcome feedback, bug reports, and contributions to help stabilize the library!
2124
2225
## 📋 Table of Contents
@@ -135,6 +138,8 @@ Plotly.cpp requires the following dependencies:
135138

136139
## 📊 Simple Examples
137140

141+
You can find more details in [documentation](https://yhisaki.github.io/plotly.cpp/examples.html).
142+
138143
### Hello World Example
139144

140145
```cpp
@@ -427,6 +432,8 @@ More complex examples and use cases are available in the [gallery](gallery).
427432

428433
## 🏗️ Architecture Overview
429434

435+
You can find more details in [Architecture Overview](https://yhisaki.github.io/plotly.cpp/architecture.html).
436+
430437
### Key Components
431438

432439
**1. C++ Backend (`plotly::Figure`)**

docs/mainpage.md

Lines changed: 58 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Plotly.cpp API Documentation
22

3+
![Build Status](https://img.shields.io/github/actions/workflow/status/yhisaki/plotly.cpp/ci.yml?branch=main)
4+
[![codecov](https://codecov.io/gh/yhisaki/plotly.cpp/graph/badge.svg?token=NsLJgwCpau)](https://codecov.io/gh/yhisaki/plotly.cpp)
5+
![Version](https://img.shields.io/github/v/tag/yhisaki/plotly.cpp?label=version)
6+
![License](https://img.shields.io/github/license/yhisaki/plotly.cpp)
7+
![C++ Standard](https://img.shields.io/badge/C%2B%2B-17%2B-blue.svg)
8+
![Platform](https://img.shields.io/badge/platform-Linux-lightgrey)
9+
310
## Overview
411

512
**Plotly.cpp** brings the power of [Plotly.js](https://plotly.com/javascript/) to C++. This library provides a modern C++17 interface for creating interactive data visualizations with real-time updates, event handling, and export capabilities.
@@ -24,6 +31,55 @@
2431

2532
![Bidirectional Events](/docs/images/event_handling.gif)
2633

34+
## Installation & Quick Start
35+
36+
### Prerequisites
37+
38+
- **Ubuntu Linux** (tested platform)
39+
- **Chrome/Chromium** browser
40+
- **C++17 or higher**
41+
42+
### Installation
43+
44+
#### Install from deb package (Recommended)
45+
46+
```bash
47+
wget https://github.com/yhisaki/plotly.cpp/releases/download/v0.1.0/libplotly-cpp-0.1.0-Linux.deb
48+
sudo apt install ./libplotly-cpp-0.1.0-Linux.deb
49+
```
50+
51+
#### Install from FetchContent
52+
53+
Add to your CMake project using FetchContent:
54+
55+
```cmake
56+
include(FetchContent)
57+
58+
FetchContent_Declare(
59+
plotly-cpp
60+
GIT_REPOSITORY https://github.com/yhisaki/plotly.cpp.git
61+
GIT_TAG v0.1.0
62+
)
63+
64+
FetchContent_MakeAvailable(plotly-cpp)
65+
```
66+
67+
#### Usage
68+
69+
After installation, add the following to your `CMakeLists.txt`:
70+
71+
```cmake
72+
find_package(plotly-cpp REQUIRED)
73+
74+
target_link_libraries(your_target plotly-cpp::plotly-cpp)
75+
```
76+
77+
#### Dependencies
78+
79+
Plotly.cpp requires the following dependencies:
80+
81+
- [**nlohmann/json**](https://github.com/nlohmann/json) - JSON serialization/deserialization. You can install it by `sudo apt install nlohmann-json3-dev`.
82+
2783
## Architecture
2884

2985
The library uses a **client-server architecture**:
@@ -37,6 +93,8 @@ The library uses a **client-server architecture**:
3793
- Plotly.js runtime for visualization
3894
- Event bridge for user interactions
3995

96+
You can find more details in [Architecture Overview](architecture.md).
97+
4098
## Quick Start
4199

42100
```cpp
@@ -81,18 +139,6 @@ int main() {
81139
| @ref plotly::Figure::extendTraces() | [`Plotly.extendTraces()`](https://plotly.com/javascript/plotlyjs-function-reference/#plotlyextendtraces) | Stream real-time data |
82140
| @ref plotly::Figure::on() | [Event listeners](https://plotly.com/javascript/plotlyjs-events/) | Handle user interactions |
83141

84-
## Getting Started
85-
86-
1. **Installation** - See [Installation & Quick Start](https://github.com/yhisaki/plotly.cpp#-installation--quick-start) for installation instructions
87-
2. **API Reference** - Browse the class documentation starting with @ref plotly::Figure or see [Complete API Reference](https://github.com/yhisaki/plotly.cpp#-complete-api-reference)
88-
3. **Examples** - Check the `gallery/` directory for comprehensive examples
89-
90-
## Dependencies
91-
92-
- **C++17 or higher**
93-
- **nlohmann/json** - JSON serialization (auto-fetched if not found)
94-
- **Chrome/Chromium browser** - For visualization frontend
95-
96142
---
97143

98144
For complete examples and advanced usage, visit the [project repository](https://github.com/yhisaki/plotly.cpp).

0 commit comments

Comments
 (0)