Skip to content

Commit 419ab9e

Browse files
committed
Fix: more review edits
1 parent f13d330 commit 419ab9e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

tutorials/add-readme.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ In this lesson you will learn:
1919
The `README.md` file is a markdown file located at the root of your project directory that helps
2020
a user understand:
2121

22-
- You package's name and what it does
22+
- You package's name
23+
- What the package does. Your README file should clearly state the problem(s) that your software is designed to solve and its target audience.
2324
- The current development "state" of the package (through badges)
2425
- How to get started with using your package.
2526
- How to contribute to your package
@@ -175,25 +176,25 @@ with the Journal of Open Source Software.
175176
Your finished `README.md` file should look something like this:
176177

177178
````markdown
178-
# pyOpenSci-package
179+
# pyosPackage
179180

180181
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8365068.svg)](https://doi.org/10.5281/zenodo.8365068)
181182
[![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/115)
182183

183-
## What packagename does
184+
## What pyosPackage does
184185

185186
Short description here using non-technical language that describes what your package does.
186187

187-
## How to install
188+
## How to install pyosPackage
188189

189190
<todo - when i add more to the pyos package this can use that readme>
190191
To install this package run:
191192

192-
`pip install packagename`
193+
`pip install pyosPackage`
193194

194195
## OPTIONAL - if you have additional setup instructions add them here. if not, skip this section.
195196

196-
## Get started using packagename
197+
## Get started using pyosPackage
197198

198199
Here add a quick code demo showing a user how to use the package after it is installed.
199200

@@ -210,10 +211,9 @@ You can also add any links to tutorials in your documentation here.
210211

211212
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.
212213

213-
## How to cite packagename
214+
## How to cite pyosPackage
214215

215216
citation information here
216-
````
217217

218218
## <i class="fa-solid fa-hands-bubbles"></i> Wrap up
219219

0 commit comments

Comments
 (0)