You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
author: Chezka Quinola, Brandon Thompson, DJ Battle, Jordi Tort, Gregory M. Kapfhammer
6
+
author: Chezka Quinola, Brandon Thompson, DJ Battle, Jordi Tort
7
7
execute:
8
8
echo: true
9
9
format:
@@ -63,8 +63,8 @@ format:
63
63
64
64
<!--DJ-->
65
65
## Why It’s Helpful
66
-
- It forces you to write documation before coding
67
-
- You can see what evryone is doing without having to explain the code
66
+
- It forces you to write documentation before coding
67
+
- You can see what everyone is doing without having to explain the code
68
68
- Lays out the guidelines for each member of the team to follow easily
69
69
70
70
---
@@ -79,19 +79,24 @@ format:
79
79
80
80
<!--brandon-->
81
81
## Best Tips
82
+
83
+
::: {.incremental style="font-size: 0.9em;"}
84
+
82
85
- Keep new users in mind
83
86
- Make sure your `README` is structured to be not only accessible but also understandable for new users
84
87
- Clearly outline your project
85
88
- Make sure that your `README` explains the project that you're doing and also why you are doing it, as well as the problem it solves and what makes it stand out.
86
89
- Define key features
87
90
- On top of outlining the project and why you're doing it make sure to include the project's key features
88
91
92
+
:::
93
+
89
94
---
90
95
91
96
<!--brandon-->
92
97
## Wrap-Up
93
98
- README is your project’s front door
94
-
- README introduces your project in a way thats easy to understand
99
+
- README introduces your project in a way that is easy to understand
95
100
- It helps your team stay organized and on task, as well as helping to avoid problems
96
101
- Clear docs = happy users
97
102
- README clearly outlines your project reducing confusion for users
0 commit comments