Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
facontidavide authored Jan 16, 2024
1 parent abcad9e commit 186cca5
Showing 1 changed file with 29 additions and 29 deletions.
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Noteworthy features:

- Load CSV files.
- Load [ULog](https://dev.px4.io/v1.9.0/en/log/ulog_file_format.html) (PX4).
- Subscribe to many different streaming sources: MQTT, Websockets, ZeroMQ, UDP, etc.
- Understands data formats such as JSON, CBOR, BSON, Message Pack, etc.
- Subscribe to many different streaming sources: MQTT, WebSockets, ZeroMQ, UDP, etc.
- Understand data formats such as JSON, CBOR, BSON, Message Pack, etc.
- Well integrated with [ROS](https://www.ros.org/): open *rosbags* and/or subscribe to ROS *topics* (both ROS1 and ROS2).
- Supports the [Lab Streaming Layer](https://labstreaminglayer.readthedocs.io/info/intro.html), that is used by [many devices](https://labstreaminglayer.readthedocs.io/info/supported_devices.html).
- Easily add your custom data source and/or formats...
Expand All @@ -45,7 +45,7 @@ You can manipulate your time series using a simple and extendable Transform Edit

![](docs/function_editor.png)

Alternatively, you may use the Custom Function Editor, that allows you to create Multi-input / Single-output functions
Alternatively, you may use the Custom Function Editor, which allows you to create Multi-input / Single-output functions
using a scripting language based on [Lua](https://www.tutorialspoint.com/lua/index.htm).

If you are not familiar with Lua, don't be afraid, you won't need more than 5 minutes to learn it ;)
Expand All @@ -62,7 +62,7 @@ To learn how to use PlotJuggler, check the tutorials here:

## Supported plugins

Some plugin can be found in a different repository. The individual README files
Some plugins can be found in a different repository. The individual README files
*should* include all the information needed to compile and use the plugin.

Please submit specific issues, Pull Requests and questions on the related Github repository:
Expand All @@ -77,6 +77,24 @@ If you want a simple example to learn how to write your own plugins, have a look

## Installation

## Install with Snap (recommended in Ubuntu, even for ROS users)

The snap contains a version of PlotJuggler that can work with either ROS1 or ROS2.

![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)

To install it in Ubuntu 22.04, with ROS2 support, run:

```
sudo snap install plotjuggler
```

If you are still using ROS1 (Ubuntu 20.04), install instead:

```
sudo snap install plotjuggler-ros
```

### Binary installers

Note that these installers do __not__ include ROS plugins.
Expand Down Expand Up @@ -108,37 +126,19 @@ ros2 run plotjuggler plotjuggler

ROS plugins are available in a separate repository: https://github.com/PlotJuggler/plotjuggler-ros-plugins

Refer to the instructions in that repository if you want to compile PJ and its ROS plugins from source.

## Install with Snap

This massive file will install a version of PlotJuggler that can work with both ROS1 and ROS2.

![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)

To install it in Ubuntu 22.04, with ROS2 support, run:

```
sudo snap install plotjuggler
```

If you are still use ROS1 (Ubuntu 20.04), install instead:

```
sudo snap install plotjuggler-ros
```
Please take a look at the instructions in that repository if you want to compile PJ and its ROS plugins from source.


## Compile from source

You can find find the detailed instructions here: [COMPILE.md](COMPILE.md).
You can find the detailed instructions here: [COMPILE.md](COMPILE.md).

# Sponsorship and commercial support

PlotJuggler required a lot of work to be developed; my goal is to build the most
intuitive and powerfull tool to visualize data and timeseries.
PlotJuggler required a lot of work to develop and maintain; my goal is to build the most
intuitive and powerful tool to visualize data and timeseries.

If you find PlotJuggler useful, consider making a donation on [PayPal](https://www.paypal.me/facontidavide) or become a
If you find PlotJuggler useful, consider donating [PayPal](https://www.paypal.me/facontidavide) or becoming a
[Github Sponsor](https://github.com/sponsors/facontidavide).

If you need to extend any of the functionalities of PlotJuggler to cover a specific
Expand All @@ -148,9 +148,9 @@ support from the main author, [Davide Faconti](mailto:[email protected]).
# License

PlotJuggler is released under the [Mozilla Public License Version 2.0](LICENSE.md),
which allows user to develop closed-source plugins.
which allows users to develop closed-source plugins.

Please note that some third party dependencies (including Qt) use the
Please note that some third-party dependencies (including Qt) use the
**GNU Lesser General Public License**.

# Star History
Expand Down

0 comments on commit 186cca5

Please sign in to comment.