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
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
In the previous lessons you learned:
4
4
5
5
1. What a Python package is
6
-
2. How to make your code installable and
6
+
2. How to make your code installable
7
7
3. How to publish your package to (test) PyPI
8
8
9
9
:::{admonition} Learning objectives
@@ -56,13 +56,13 @@ At the top of the `README.md` file, add the name of your package.
56
56
57
57
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
58
58
59
-
* Broken documentation and test builds
59
+
* Broken documentation and test builds.
60
60
* Versions of your package that are on PyPI and Conda.
61
61
* Whether your package has been reviewed and vetted by an organization such as pyOpenSci and/or JOSS.
62
62
63
63
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.
64
64
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.
66
66
67
67
### Step 3 - Add a description of what your package does
68
68
@@ -102,8 +102,8 @@ Here, briefly document (or link to documentation for) any
102
102
additional setup that is required to use your package.
103
103
This might include:
104
104
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.
107
107
108
108
:::{note}
109
109
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:
124
124
3
125
125
``````
126
126
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
128
128
you don't have this yet, you can leave it empty for the time being.
129
129
130
130
This would
@@ -134,7 +134,7 @@ help users understand how to use your package for common workflows.
134
134
135
135
### Step 7 - Community section
136
136
137
-
The community section of your READMEfileis 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 READMEfileis 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.
138
138
139
139
In the community section, you will add links to your contributing guide
140
140
and`CODE_OF_CONDUCT.md`. You will add a [`CODE_OF_CONDUCT.md`filein 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
0 commit comments