Skip to content

Commit eda462d

Browse files
Update README (#322)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
1 parent 0629bba commit eda462d

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

readme.rst

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@ blurb_it
22
--------
33

44
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
5-
:target: https://github.com/ambv/black
5+
:target: https://github.com/psf/black
66

77
.. image:: https://github.com/python/blurb_it/actions/workflows/ci.yml/badge.svg?event=push
88
:target: https://github.com/python/blurb_it/actions
99

10-
.. image:: https://codecov.io/gh/python/blurb_it/branch/master/graph/badge.svg
10+
.. image:: https://codecov.io/gh/python/blurb_it/branch/main/graph/badge.svg
1111
:target: https://codecov.io/gh/python/blurb_it
1212

13-
1413
``blurb add`` over the internet.
1514

1615
About
@@ -19,8 +18,9 @@ About
1918
📜🤖 blurb-it allows you to add a misc/news file to your own
2019
`CPython <https://github.com/python/cpython>`_ pull request.
2120

22-
Misc/News file `is needed <https://devguide.python.org/committing/#what-s-new-and-news-entries>`_ for
23-
almost all non-trivial changes to CPython.
21+
A ``Misc/NEWS.d`` file `is needed
22+
<https://devguide.python.org/core-developers/committing/index.html#updating-news-and-what-s-new-in-python>`_
23+
for almost all non-trivial changes to CPython.
2424

2525
To use blurb-it, you must be logged in to GitHub.
2626

@@ -61,11 +61,10 @@ Requirements and dependencies
6161
- cryptography
6262

6363

64-
Running Tests
64+
Running tests
6565
=============
6666

67-
1. Install pyhon virtual environment with `$ python3 -m venv venv`.
68-
2. Activate virtual environment with `$ . venv/bin/activate`.
69-
3. Install dev-requirements with `(venv)$ pip install -r dev-requirements.txt`.
70-
4. Run all test with `(venv)$ pytest tests`.
71-
67+
1. Create a Python virtual environment with ``$ python3 -m venv venv``
68+
2. Activate the virtual environment with ``$ . venv/bin/activate``
69+
3. Install dev requirements with ``(venv)$ pip install -r dev-requirements.txt``
70+
4. Run all tests with ``(venv)$ pytest tests``

0 commit comments

Comments
 (0)