Skip to content

Commit e778f71

Browse files
cal0pteryxlovetox
authored andcommitted
cq: Improve Readme formatting
1 parent 048321c commit e778f71

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,41 @@
33
[![PyPI](https://img.shields.io/pypi/v/pygobject-stubs)](https://pypi.org/project/PyGObject-stubs)
44

55
## Installation
6-
```
7-
$ pip install pygobject-stubs
6+
7+
```shell
8+
pip install pygobject-stubs
89
```
910

1011
### Configuration
1112

12-
Some libraries exist in multiple versions like Gtk3/4. As both libraries are
13-
currently imported under the namespace `Gtk` only stubs for one can be installed.
13+
Some libraries exist in multiple versions like Gtk3/4.
14+
As both libraries are currently imported under the namespace `Gtk` only stubs for one can be installed.
1415

15-
You need to decide this at install time either by using the `--config-settings` option
16-
with pip
16+
You need to decide this at install time either by using the `--config-settings` option with pip:
1717

18-
$ pip install pygobject-stubs --no-cache-dir --config-settings=config=Gtk3,Gdk3,Soup2
18+
```shell
19+
pip install pygobject-stubs --no-cache-dir --config-settings=config=Gtk3,Gdk3,Soup2
20+
```
1921

20-
or by setting the `PYGOBJECT_STUB_CONFIG` env variable
22+
or by setting the `PYGOBJECT_STUB_CONFIG` env variable:
2123

22-
$ PYGOBJECT_STUB_CONFIG=Gtk3,Gdk3,Soup2 pip install --no-cache-dir pygobject-stubs
24+
```shell
25+
PYGOBJECT_STUB_CONFIG=Gtk3,Gdk3,Soup2 pip install --no-cache-dir pygobject-stubs
26+
```
2327

2428
If no configuration is set, the most recent version of each library is installed.
2529

26-
`--no-cache-dir` is only necessary on subsequent reinstalls, otherwise the stubs will not
27-
be rebuild and a cache of a previous installation is used.
30+
`--no-cache-dir` is only necessary on subsequent reinstalls, otherwise the stubs will not be rebuild and a cache of a previous installation is used.
2831

2932
### Project Integration
3033

3134
Usually you want the stubs to be installed as part of the development dependencies.
3235
`pyproject.toml` does not allow to pass `config-settings` to requirements.
33-
If you need specific versions of some libraries you can use a `requirements.txt` file instead, which
34-
allows to pass `config-settings` per requirement as of pip >= 23.1.0.
36+
If you need specific versions of some libraries you can use a `requirements.txt` file instead, which allows to pass `config-settings` per requirement as of pip >= 23.1.0.
3537

36-
$ pip install . -r dev.txt
38+
```shell
39+
pip install . -r dev.txt
40+
```
3741

3842
## Contributing
3943

0 commit comments

Comments
 (0)