Skip to content

Commit 07de925

Browse files
authored
rename "TL;DR" to "Installation" in README.md (#408)
1 parent 7239b4f commit 07de925

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,17 @@ If interested in contributing to PyPartMC, please have a look a the [notes for d
3030
[![PyPI version](https://badge.fury.io/py/PyPartMC.svg)](https://pypi.org/p/PyPartMC)
3131
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
3232

33-
## TL;DR (try in a Jupyter notebook)
34-
3533
[![Python 3](https://img.shields.io/static/v1?label=Python&logo=Python&color=3776AB&message=3)](https://www.python.org/)
3634
[![Linux OK](https://img.shields.io/static/v1?label=Linux&logo=Linux&color=yellow&message=%E2%9C%93)](https://en.wikipedia.org/wiki/Linux)
3735
[![macOS OK](https://img.shields.io/static/v1?label=macOS&logo=Apple&color=silver&message=%E2%9C%93)](https://en.wikipedia.org/wiki/macOS)
3836
[![Windows OK](https://img.shields.io/static/v1?label=Windows&logo=Windows&color=white&message=%E2%9C%93)](https://en.wikipedia.org/wiki/Windows)
3937
[![Jupyter](https://img.shields.io/static/v1?label=Jupyter&logo=Jupyter&color=f37626&message=%E2%9C%93)](https://jupyter.org/)
4038

41-
```python
42-
! pip install PyPartMC
43-
import PyPartMC
39+
## Installation
40+
41+
### Using the command-line `pip` tool (also applies to conda environments)
42+
```bash
43+
pip install PyPartMC
4444
```
4545

4646
Note that, depending on the environment (OS, hardware, Python version), the pip-install invocation
@@ -49,6 +49,13 @@ In the latter case, a Fortran compiler and some development tools includiong CMa
4949
are required (while all non-Python dependencies are included in the PyPartMC source archive).
5050
In both cases, all Python dependencies will be resolved by pip.
5151

52+
### In a Jupyter notebook cell (also on Colab or jupyter-hub instances)
53+
54+
```python
55+
! pip install PyPartMC
56+
import PyPartMC
57+
```
58+
5259
#### Jupyter notebooks with examples
5360
Note: clicking the badges below redirects to cloud-computing platforms. The mybinder.org links allow anonymous execution, Google Colab requires logging in with a Google account, ARM JupyerHub requires logging in with an ARM account (and directing Jupyter to a particular notebook within the `examples` folder).
5461

0 commit comments

Comments
 (0)