Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🥳 Tweaks to README and tutorials #61

Merged
merged 3 commits into from
Sep 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Build | Status
Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-plugin/branch/ign-plugin1/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-plugin/branch/ign-plugin1)
Ubuntu Bionic | [![Build Status](https://build.osrfoundation.org/job/ignition_plugin-ci-ign-plugin1-bionic-amd64/badge/icon)](https://build.osrfoundation.org/job/ignition_plugin-ci-ign-plugin1-bionic-amd64/)
Homebrew | [![Build Status](https://build.osrfoundation.org/job/ignition_plugin-ci-ign-plugin1-bionic-amd64/badge/icon)](https://build.osrfoundation.org/job/ignition_plugin-ci-ign-plugin1-bionic-amd64/)
Windows 7 | [![Build Status](https://build.osrfoundation.org/job/ignition_plugin-ci-ign-plugin1-windows7-amd64/badge/icon)](https://build.osrfoundation.org/job/ignition_plugin-ci-ign-plugin1-windows7-amd64/)
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_plugin-ign-1-win)](https://build.osrfoundation.org/job/ign_plugin-ign-1-win/)

**Library for registering plugin libraries and dynamically loading them at runtime.**

Expand All @@ -21,6 +21,18 @@ of libraries designed to rapidly develop robot applications.

[http://ignitionrobotics.org](http://ignitionrobotics.org)

## Features

* Registration of **templated and non-templated** classes from any translation unit.
* Querying of interfaces **by C++ type or name string**.
* **Dynamically load** plugins at runtime according to the interfaces they provide.
* **Reference counting** of plugin objects to unload libraries no longer in use.
* **Command line tool** `ign plugin` to inspect plugins.

## Installation

See the [installation tutorial](https://ignitionrobotics.org/api/plugin/1.2/installation.html).

# Documentation

API documentation and tutorials can be accessed at [https://ignitionrobotics.org/libs/plugin](https://ignitionrobotics.org/libs/plugin)
6 changes: 3 additions & 3 deletions tutorials/01_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ following concepts:
* A "Library" may contain multiple plugins, which provides a convenient
way to distribute different types of functionality in a single file.

The loader component can dynamically load plugin interfaces at runtime
The **loader** component can dynamically load plugin interfaces at runtime
either by specifying a desired plugin or by listing plugins within a library
file that provide a specific interface.
There are highly performant ways to get direct access to a plugin interace
Expand All @@ -24,13 +24,13 @@ compile time.
The loader also can use reference counting of plugin objects to unload
libraries that are no longer in use.

The register component provides macros for registering templated and
The **register** component provides macros for registering templated and
non-templated classes as plugins and/or interfaces.
A plugin can be registered anywhere from within any translation unit.
Interfaces can be queried by their C++ type, or they can be queried by
name with a string.

The [ignition-physics](https://ignitionrobotics.org/libs/physics) Feature
The [Ignition Physics](https://ignitionrobotics.org/libs/physics) Feature
system provides a good example of the use of these unique aspects of
ignition-plugin.

7 changes: 5 additions & 2 deletions tutorials/02_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,15 @@ sudo apt install libignition-plugin-dev

## Source Installation

1. Install Ignition dependencies
1. Install required Ignition dependencies
```bash
sudo apt-get install libignition-cmake2-dev
```

1. Install Ignition Tools if you want to use the `ign plugin` command line tool:
```bash
sudo apt-get install ignition-tools

2. Clone the repository
```bash
git clone https://github.com/ignitionrobotics/ign-plugin
Expand Down Expand Up @@ -187,7 +191,6 @@ You can also generate the documentation from a clone of this repository by follo
```

2. Clone the repository

```bash
git clone https://github.com/ignitionrobotics/ign-plugin
```
Expand Down