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

add documentation link to README #355

Merged
merged 2 commits into from
Sep 29, 2023
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/ubuntu-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,42 @@ jobs:
- name: make
run: make
- name: make check
id: make-check
run: make check
- name: Show logs on failure
if: ${{ failure() && steps.make-check.outcome == 'failure' }}
run: |
more test-suite.log
- name: configure with SN Enabled
run: ./configure --enable-sn
- name: make
run: make
- name: make check
id: make-check-sn
run: make check
- name: Show logs on failure
if: ${{ failure() && steps.make-check-sn.outcome == 'failure' }}
run: |
more test-suite.log
- name: configure with Non-Block
run: ./configure --enable-nonblock CFLAGS="-DWOLFMQTT_TEST_NONBLOCK"
- name: make
run: make
- name: make check
id: make-check-nonblock
run: make check
- name: Show logs on failure
if: ${{ failure() && steps.make-check-nonblock.outcome == 'failure' }}
run: |
more test-suite.log
- name: configure with Non-Block and Multi-threading
run: ./configure --enable-mt --enable-nonblock CFLAGS="-DWOLFMQTT_TEST_NONBLOCK"
- name: make
run: make
- name: make check
id: make-check-nonblock-mt
run: make check
- name: Show logs on failure
if: ${{ failure() && steps.make-check-nonblock-mt.outcome == 'failure' }}
run: |
more test-suite.log
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

This is an implementation of the MQTT Client written in C for embedded use, which supports SSL/TLS via the wolfSSL library. This library was built from the ground up to be multi-platform, space conscious and extensible. Integrates with wolfSSL to provide TLS support.

For details on wolfMQTT [see the wolfMQTT Manual](https://www.wolfssl.com/documentation/manuals/wolfmqtt/wolfMQTT-Manual.pdf).

## Building

Expand Down