@@ -52,7 +52,7 @@ the readme will already be there-->
52
52
53
53
At the top of the ` README.md ` file, add the name of your package.
54
54
55
- if you are using markdown it should be an header 1 tag which is denoted with a single ` # ` sign.
55
+ If you are using markdown it should be a header 1 tag which is denoted with a single ` # ` sign.
56
56
57
57
` # Package-title-here `
58
58
@@ -160,14 +160,14 @@ As your package grows you may also have a link to a development guide that contr
160
160
### Step 8 - Citation information
161
161
162
162
Finally it is important to let users know how to cite your package.
163
- You can communication citation information in a few different ways.
163
+ You can communicate citation information in a few different ways.
164
164
165
165
You can use a tool such as zenodo to create a DOI and associated citation
166
166
information for your package if it is hosted on a platform such as
167
167
GitHub. [ Check out this short tutorial that covers setting that up.] ( https://coderefinery.github.io/github-without-command-line/doi/ )
168
168
169
169
Alternatively if you send your package through a peer review process such
170
- as the [ one lead by pyOpenSci] ( https://www.pyopensci.org/about-peer-review/index.html ) , then you can all get a cross-ref DOI through our partnership
170
+ as the [ one lead by pyOpenSci] ( https://www.pyopensci.org/about-peer-review/index.html ) , then you can get a cross-ref DOI through our partnership
171
171
with the Journal of Open Source Software.
172
172
173
173
## The finished README file
@@ -204,7 +204,7 @@ Here add a quick code demo showing a user how to use the package after it is ins
204
204
205
205
```
206
206
207
- You can also add any to tutorials in your documentation here.
207
+ You can also add any links to tutorials in your documentation here.
208
208
209
209
## Community
210
210
0 commit comments