File tree Expand file tree Collapse file tree 1 file changed +11
-5
lines changed Expand file tree Collapse file tree 1 file changed +11
-5
lines changed Original file line number Diff line number Diff line change @@ -157,14 +157,20 @@ As your package grows you may also have a link to a development guide that contr
157
157
158
158
159
159
160
- ### Step 8 - Citation & License information
160
+ ### Step 8 - Citation information
161
161
162
- Finally it is important to let users know:
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
164
164
- 1 . how to cite your package and
165
- 2 . what the license is.
165
+ You can use a tool such as zenodo to create a DOI and associated citation
166
+ information for your package if it is hosted on a platform such as
167
+ GitHub. [ Check out this short tutorial that covers setting that up.] ( https://coderefinery.github.io/github-without-command-line/doi/ )
166
168
167
- You will create a license file for your package in this lesson.
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
171
+ with the Journal of Open Source Software.
172
+
173
+ ## The finished README file
168
174
169
175
Your finished ` README.md ` file should look something like this:
170
176
You can’t perform that action at this time.
0 commit comments