Skip to content

Commit 2f9919d

Browse files
lwasserkierisi
andcommitted
Fix: edits from @kierSi
Co-authored-by: Jesse Mostipak <jesse.maegan@gmail.com>
1 parent 312540a commit 2f9919d

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
@@ -3,7 +3,7 @@
33
In the previous lessons you learned:
44

55
1. What a Python package is
6-
2. How to make your code installable and
6+
2. How to make your code installable
77
3. How to publish your package to (test) PyPI
88

99
:::{admonition} Learning objectives
@@ -56,13 +56,13 @@ At the top of the `README.md` file, add the name of your package.
5656

5757
It's common for maintainers to add badges to the top of their README files. Badges allow you and your package users to track things like
5858

59-
* Broken documentation and test builds
59+
* Broken documentation and test builds.
6060
* Versions of your package that are on PyPI and Conda.
6161
* Whether your package has been reviewed and vetted by an organization such as pyOpenSci and/or JOSS.
6262

6363
If you have already published your package to pypi.org you can use [shields.io to create a package version badge](https://shields.io/badges/py-pi-version). This badge will dynamically update as you release new versions of your package to PyPI.
6464

65-
If not you can leave the top empty for now and add badges to your README at a later point as they make sense for your package.
65+
If not, you can leave the top empty for now and add badges to your README at a later point as they make sense for your package.
6666

6767
### Step 3 - Add a description of what your package does
6868

@@ -102,8 +102,8 @@ Here, briefly document (or link to documentation for) any
102102
additional setup that is required to use your package.
103103
This might include:
104104

105-
* authentication information if it is applicable to your package.
106-
* additional tool installations such as GDAL.
105+
* authentication information, if it is applicable to your package.
106+
* additional tool installations, such as GDAL.
107107

108108
:::{note}
109109
Many packages won't need this section in their README. In that case you can always skip this section!
@@ -124,7 +124,7 @@ For the pyosPackage, a short get started demo might look like this:
124124
3
125125
``````
126126

127-
Or it could simply be a link to a get started tutorial that you have created. If
127+
Or it could simply be a link to a getting started tutorial that you have created. If
128128
you don't have this yet, you can leave it empty for the time being.
129129

130130
This would
@@ -134,7 +134,7 @@ help users understand how to use your package for common workflows.
134134

135135
### Step 7 - Community section
136136

137-
The community section of your README file is a place to include information for users who may want to engage with your project. This engagement will likely happen either on a platform like GitHub or GitLab.
137+
The community section of your README file is a place to include information for users who may want to engage with your project. This engagement will likely happen on a platform like GitHub or GitLab.
138138

139139
In the community section, you will add links to your contributing guide
140140
and `CODE_OF_CONDUCT.md`. You will add a [`CODE_OF_CONDUCT.md` file in the next lesson](add-license-coc).
@@ -145,7 +145,7 @@ As your package grows you may also have a link to a development guide that contr
145145

146146
### Step 8 - Citation & License information
147147

148-
Finally it is important to let users know
148+
Finally it is important to let users know:
149149

150150
1. how to cite your package and
151151
2. what the license is.

0 commit comments

Comments
 (0)