Skip to content
Snippets Groups Projects
Commit 677db94e authored by Abhishek Racharla's avatar Abhishek Racharla
Browse files

uploading README.md file for ref.

parent 38d49d0d
No related branches found
No related tags found
No related merge requests found
CubeJSONPlugin
CubeJSONPlugin is a plugin for the CubeGUI tool that visualizes the system tree structure in JSON format. It is designed to provide a user-friendly way to explore and interact with the hierarchical data within Cube performance analysis files.
Features:
- Adds a custom tab to CubeGUI called "System Tree JSON."
- Visualizes the system tree structure in a JSON-like format.
- Provides interactive features such as tree item selection and display updates.
- Lightweight and easy to integrate into existing CubeGUI installations.
Prerequisites
-To build and use this plugin, you will need:
CubeGUI: Version 4.9 or later.
Qt: Version 5.x or later.
C++ Compiler: Compatible with the version of Qt and CubeGUI you are using.
CMake (preferred) or qmake for building the project.
Installation
Step 1: Build the Plugin
Clone this repository to your local machine:
bash
git clone https://github.com/ar16048/CubeJSONPlugin.git
cd CubeJSONPlugin
Build the plugin using CMake:
bash
mkdir build
cd build
cmake ..
make
Alternatively, if you prefer qmake:
bash
qmake
make
Step 2: Deploy the Plugin
Locate the built shared library file (e.g., libCubeJsonPlugin.so for Linux).
Copy the file to the Cube plugin directory:
bash
sudo cp libCubeJsonPlugin.so /opt/cube/lib64/plugins/
Step 3: Verify Installation
Launch CubeGUI in verbose mode to verify the plugin is loaded:
bash
cube -verbose
Check for any errors during the plugin loading process. If successful, the plugin will appear as a new tab in the Cube interface.
Usage
Open a Cube file in CubeGUI.
Navigate to the "System Tree JSON" tab to explore the system tree structure visualized in JSON format.
Click on system tree items to see their details dynamically updated in the interface.
Development
If you'd like to contribute or modify the plugin, follow these steps:
Modify the source files in the src/ directory.
Rebuild the plugin by running the build commands mentioned above.
Test the plugin using CubeGUI.
Troubleshooting
Plugin Not Loading: Ensure the plugin was built with the same compiler and configuration options as CubeGUI.
Missing Dependencies: Verify that all required Qt and Cube development libraries are installed.
Error Messages: Run CubeGUI in verbose mode (cube -verbose) to identify potential issues.
Contributing
Contributions are welcome! Feel free to fork this repository and submit a pull request with your improvements.
License
This project is licensed under the MIT License. See the LICENSE file for details.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment