Skip to content

Commit 9cba6c6

Browse files
authored
Update README.md
1 parent 8a4f691 commit 9cba6c6

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A fast plotting library built using the `pygfx` render engine that can use [Vulk
66
Checkout pygfx!
77
https://github.com/pygfx/pygfx
88

9-
`fastplotlib` is very experimental but you're welcome to try it out or contribute!
9+
`fastplotlib` is in the alpha stage and experimental but you're welcome to try it out or contribute!
1010

1111
Questions, ideas? Chat on gitter: https://gitter.im/fastplotlib/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link
1212

@@ -49,29 +49,24 @@ plot.show()
4949

5050
# Installation
5151

52-
Install directly from GitHub until I stabilize things.
53-
54-
```bash
55-
pip install git+https://github.com/kushalkolar/fastplotlib.git
56-
```
57-
58-
Don't install from PYPI (I had to take the name `fastplotlib` before someone else did).
59-
60-
You will need a GPU that supports Vulkan (iGPUs in CPUs should be fine).
61-
Generally if your GPU is from 2017 or later it should support Vulkan.
62-
63-
## For development
52+
Install directly from GitHub.
6453

6554
```bash
6655
git clone https://github.com/kushalkolar/fastplotlib.git
6756
cd fastplotlib
57+
pip install -r requirements.txt
6858
pip install -e .
6959

7060
# try the examples
7161
cd examples
7262
jupyter lab
7363
```
7464

65+
Don't install from PYPI, `fastplotlib` is in the alpha stage, the pip package is not regularly updated yet.
66+
67+
You will need a GPU that supports Vulkan (iGPUs in CPUs should be fine).
68+
Generally if your GPU is from 2017 or later it should support Vulkan.
69+
7570
## Install Vulkan drivers and other stuff
7671

7772
For more information see: https://github.com/pygfx/wgpu-py#platform-requirements

0 commit comments

Comments
 (0)