Skip to content

Commit

Permalink
doc: add linux documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiasstraka committed Aug 31, 2023
1 parent b25005c commit af44a9d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/ubuntu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
submodules: true

- name: Install dev requirements
run: sudo apt install -yq libfmt-dev libpaho-mqtt-dev libpaho-mqttpp-dev qtbase5-dev
run: sudo apt install -yq libfmt-dev libpaho-mqtt-dev libpaho-mqttpp-dev qtbase5-dev uuid-dev

- name: Configure CMake
run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_COMPILER=g++ -DBUILD_PLUGIN_WITH_TESTS=OFF
Expand Down
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,21 @@ To get started, Visual Studio Code with the following extensions can be used:
- C++ TestMate to run Unit-Tests directly inside VS-Code

If you have OXYGEN installed on the default path and you start debugging, the compiled plugin gets automatically copied to the correct folder and OXYGEN is started. The Debugger will then attach to OXYGEN, allowing you to debug the plugin directly in VS-Code. To find out how this is done or how to change the default build-settings using the CMake extension, have a look at launch.json, settings.json and tasks.json.

### Ubuntu 22.04
In order to build the plugin on Ubuntu 22.04, you need to install the following development libraries:

```
sudo apt install -yq cmake g++ libfmt-dev libpaho-mqtt-dev libpaho-mqttpp-dev qtbase5-dev uuid-dev
```

You can build the plugin using any IDE with CMake support.
Or, to manually build the plugin from the command line, open a terminal in the folder where the MQTT plugin source is cloned into.
Then, execute the following commands to build the plugin:

```
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --target mqtt
```

To use the plugin in Oxygen, copy the `libmqtt.plugin` file from the `build/mqtt-plugin/Release/plugin` folder to `/usr/Oxygen/plugins`.

0 comments on commit af44a9d

Please sign in to comment.