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
Copy file name to clipboardExpand all lines: tutorials/add-readme.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -161,12 +161,12 @@ Your finished `README.md` file should look something like this:
161
161
162
162
## What packagename does
163
163
164
-
Short description here using nontechnical language that describes what your package does.
164
+
Short description here using non-technical language that describes what your package does.
165
165
166
166
## How to install
167
167
168
168
<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:
170
170
171
171
`pip install packagename`
172
172
@@ -183,11 +183,11 @@ a = xmethod.dosomething(var1, var2)
183
183
184
184
```
185
185
186
-
You can also add anylinks to this section to tutorials in your documentation.
186
+
You can also add any to tutorials in your documentation here.
187
187
188
188
## Community
189
189
190
-
Add information here about contributing to your package. Be sure to add links to your `CODE_OF_CONDUCT`fileand 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`fileand your development guide. For now this section might be empty. You can go back and fill it in later.
191
191
192
192
## How to cite packagename
193
193
@@ -204,7 +204,7 @@ package and as a community begins to use your package.
204
204
205
205
In the [next lesson](add-license-coc), you will add a LICENSEfile to
206
206
your Python package. A licensefileis 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:
208
208
209
209
* Builds trust with your users
210
210
* Discourages misuse of your package and associated code
0 commit comments