Skip to content

Commit e5c710c

Browse files
lwasserucodery
andcommitted
Fix: Edits from @ucodery
Co-authored-by: Jeremy Paige <ucodery@gmail.com>
1 parent 877ec8b commit e5c710c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

tutorials/add-readme.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,12 @@ Your finished `README.md` file should look something like this:
161161

162162
## What packagename does
163163

164-
Short description here using non technical language that describes what your package does.
164+
Short description here using non-technical language that describes what your package does.
165165

166166
## How to install
167167

168168
<todo - when i add more to the pyos package this can use that readme>
169-
To install this package... use:
169+
To install this package run:
170170

171171
`pip install packagename`
172172

@@ -183,11 +183,11 @@ a = xmethod.dosomething(var1, var2)
183183

184184
```
185185

186-
You can also add any links to this section to tutorials in your documentation.
186+
You can also add any to tutorials in your documentation here.
187187

188188
## Community
189189

190-
Add information here about contributing to your package. Be sure to add links to your `CODE_OF_CONDUCT` file and your development guide. For now this section might be empty. You can go back and fill it in later.
190+
Add information here about contributing to your package. Be sure to add links to your `CODE_OF_CONDUCT.md` file and your development guide. For now this section might be empty. You can go back and fill it in later.
191191

192192
## How to cite packagename
193193

@@ -204,7 +204,7 @@ package and as a community begins to use your package.
204204

205205
In the [next lesson](add-license-coc), you will add a LICENSE file to
206206
your Python package. A license file is critical as it tells users
207-
how they legally can (and can't use your package). It also:
207+
how they legally can (and can't) use your package. It also:
208208

209209
* Builds trust with your users
210210
* Discourages misuse of your package and associated code

0 commit comments

Comments
 (0)