Skip to content

Commit 6fe4f80

Browse files
Update README.rst
1 parent 99e8ba5 commit 6fe4f80

File tree

1 file changed

+29
-23
lines changed

1 file changed

+29
-23
lines changed

README.rst

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
1-
The CPython Developer's Guide
2-
=============================
1+
# The CPython Developer's Guide
32

4-
|ReadTheDocs| |Discourse| |Codestyle|
3+
[![ReadTheDocs](https://readthedocs.org/projects/cpython-devguide/badge/)](https://devguide.python.org)
4+
[![Discourse](https://img.shields.io/badge/discourse-join_chat-brightgreen.svg)](https://discuss.python.org/)
5+
[![Codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
56

6-
.. |ReadTheDocs| image:: https://readthedocs.org/projects/cpython-devguide/badge/
7-
:target: https://devguide.python.org
8-
:alt: Documentation Status
7+
Welcome to **The CPython Developer's Guide**, affectionately known as **the devguide** by the Python core team. This comprehensive guide provides essential information for contributing to CPython.
98

10-
.. |Discourse| image:: https://img.shields.io/badge/discourse-join_chat-brightgreen.svg
11-
:alt: Python Discourse chat
12-
:target: https://discuss.python.org/
9+
For the latest and official version of this guide, visit [devguide.python.org](https://devguide.python.org).
1310

14-
.. |Codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
15-
:target: https://github.com/psf/black
16-
:alt: Code style is black
11+
## Quick Start
1712

13+
### Rendering HTML
1814

19-
This guide covers how to contribute to CPython. It is known by the
20-
nickname of "the devguide" by the Python core team.
15+
To build the developer guide into HTML format, execute the following command:
2116

22-
The official home of this guide is https://devguide.python.org.
17+
```bash
18+
make html
19+
```
2320

24-
Render HTML
25-
-----------
21+
### Previewing the Guide
2622

27-
To render the devguide to HTML under ``_build/html``, run::
23+
To render the guide and view it in your browser, run:
2824

29-
make html
25+
```bash
26+
make htmlview
27+
```
3028

31-
To render the devguide to HTML, and open the result in a browser, run::
29+
### Live Editing
3230

33-
make htmlview
31+
For those who want to see changes in real-time, use:
3432

35-
To maintain a live view of edits as they are saved, run::
33+
```bash
34+
make htmllive
35+
```
3636

37-
make htmllive
37+
## Contribution Guidelines
38+
39+
We welcome contributions! Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for more details on how you can help improve the CPython project.
40+
41+
---
42+
43+
Thank you for your interest in contributing to CPython!

0 commit comments

Comments
 (0)