Skip to content

Commit fbb5146

Browse files
committed
Custom badges
GIST added in README.md Create build-badges.yml
1 parent e74d0af commit fbb5146

File tree

2 files changed

+36
-10
lines changed

2 files changed

+36
-10
lines changed

.github/workflows/build-badges.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Build custom repository badges
2+
3+
on: [push]
4+
5+
jobs:
6+
7+
create_badges:
8+
name: create_gist_badges
9+
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Create repository custom badge
14+
uses: schneegans/[email protected]
15+
with:
16+
auth: ${{ secrets.GIST_SECRET }}
17+
gistID: a9a2b2a02fda1b33461d53ddfe69d649
18+
filename: cQueue_custom_repo_badge.json
19+
label: ${{ vars.REPO_BADGE_CUSTOM_LABEL }}
20+
labelColor: ${{ vars.REPO_BADGE_CUSTOM_LABEL_COLOR }}
21+
message: ${{ vars.REPO_BADGE_CUSTOM_MESSAGE }}
22+
color: ${{ vars.REPO_BADGE_CUSTOM_MESSAGE_COLOR }}
23+
- name: Create repository activity badge
24+
uses: schneegans/[email protected]
25+
with:
26+
auth: ${{ secrets.GIST_SECRET }}
27+
gistID: a9a2b2a02fda1b33461d53ddfe69d649
28+
filename: cQueue_status_badge.json
29+
label: "Status"
30+
message: ${{ vars.REPO_STATUS }}
31+
color: ${{ vars.REPO_STATUS_COLOR }}

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77

88
![platform](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/ANY_platform.json)
99

10+
[![doxy](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/tool_DOXY.json)](https://smfsw.github.io/cQueue)
11+
[![re_note](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/tool_RN.json)](ReleaseNotes.md)
12+
13+
![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/cQueue_custom_repo_badge.json)
14+
1015
Queue handling library (written in plain c)
1116

1217
This library is designed for a c implementation on embedded devices, yet may be compiled without change with gcc for other purposes/targets.
@@ -75,16 +80,6 @@ In this particular case, dropping decision must be made before re-enabling inter
7580
- [RolloverTest.ino](examples/RolloverTest/RolloverTest.ino): Simple test to test queue rollover (for lib testing purposes mainly)
7681
- [LibTst.ino](examples/LibTst/LibTst.ino): flexible test (for lib testing purposes mainly)
7782

78-
## Documentation
79-
80-
Doxygen doc can be generated using "Doxyfile".
81-
82-
See [generated documentation](https://smfsw.github.io/cQueue/)
83-
84-
## Release Notes
85-
86-
See [release notes](ReleaseNotes.md)
87-
8883
## See also
8984

9085
[Queue](https://github.com/SMFSW/Queue) - Cpp implementation of this library

0 commit comments

Comments
 (0)