Skip to content

Commit 56d885c

Browse files
Merge pull request #15 from esciencecenter-digital-skills/badges
Add slide on badges
2 parents e6bf34a + db18c39 commit 56d885c

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

modules/good-practices-lesson/documentation-slides.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,17 @@ Note:
8080

8181
<!-- .slide: data-state="standard" -->
8282

83+
## Badges
84+
85+
Badges are a way to quickly show the status of a project: is it building, is it tested, what is the license?
86+
You typically find them on top of the README file.
87+
88+
![Badges on top of a Readme file](media/documentation/documentation-badges.png).
89+
90+
===
91+
92+
<!-- .slide: data-state="standard" -->
93+
8394
## Why write in-code documentation?
8495

8596
In-code documentation:
71.6 KB
Loading

0 commit comments

Comments
 (0)