Skip to content

Commit 34b5925

Browse files
committed
updated README.md
!!! These change will *only* be visible in the latest pre-release on PyPi !!!
1 parent e7a31b4 commit 34b5925

File tree

5 files changed

+17
-1
lines changed

5 files changed

+17
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,18 @@ This code solves the diffusion equation in 2D over a square domain which is at a
1212
## Installing the package
1313

1414
### Using pip3 to install from PyPI
15+
For the default release use:
16+
1517
```bash
1618
pip install --user --index-url https://test.pypi.org/simple/ heidrifx_diffusion2d
1719
```
1820

21+
For a pre-release version, i.e. a packed versioned by `versioneer` use for example:
22+
23+
```bash
24+
pip install --user --index-url https://test.pypi.org/simple/ heidrifx-diffusion2d==0.post0.dev4
25+
```
26+
1927
### Required dependencies
2028
```bash
2129
pip install numpy matplotlib
-9.7 KB
Binary file not shown.
9.78 KB
Binary file not shown.

heidrifx_diffusion2d.egg-info/PKG-INFO

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Metadata-Version: 2.1
22
Name: heidrifx_diffusion2d
3-
Version: 0.post0.dev4
3+
Version: 0.post0.dev5
44
Summary: A student project from the course 'Simulation Software Engineering'
55
Keywords: SSE,student project
66
Classifier: Programming Language :: Python :: 3
@@ -26,10 +26,18 @@ This code solves the diffusion equation in 2D over a square domain which is at a
2626
## Installing the package
2727

2828
### Using pip3 to install from PyPI
29+
For the default release use:
30+
2931
```bash
3032
pip install --user --index-url https://test.pypi.org/simple/ heidrifx_diffusion2d
3133
```
3234

35+
For a pre-release version, i.e. a packed versioned by `versioneer` use for example:
36+
37+
```bash
38+
pip install --user --index-url https://test.pypi.org/simple/ heidrifx-diffusion2d==0.post0.dev4
39+
```
40+
3341
### Required dependencies
3442
```bash
3543
pip install numpy matplotlib

0 commit comments

Comments
 (0)