You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
**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.
-[**nlohmann/json**](https://github.com/nlohmann/json) - JSON serialization/deserialization. You can install it by `sudo apt install nlohmann-json3-dev`.
82
+
27
83
## Architecture
28
84
29
85
The library uses a **client-server architecture**:
@@ -37,6 +93,8 @@ The library uses a **client-server architecture**:
37
93
- Plotly.js runtime for visualization
38
94
- Event bridge for user interactions
39
95
96
+
You can find more details in [Architecture Overview](architecture.md).
97
+
40
98
## Quick Start
41
99
42
100
```cpp
@@ -81,18 +139,6 @@ int main() {
81
139
|@ref plotly::Figure::extendTraces() |[`Plotly.extendTraces()`](https://plotly.com/javascript/plotlyjs-function-reference/#plotlyextendtraces)| Stream real-time data |
82
140
|@ref plotly::Figure::on() |[Event listeners](https://plotly.com/javascript/plotlyjs-events/)| Handle user interactions |
83
141
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
-
96
142
---
97
143
98
144
For complete examples and advanced usage, visit the [project repository](https://github.com/yhisaki/plotly.cpp).
0 commit comments