Skip to content

Commit fea44df

Browse files
committed
Add a quick start section to the README
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent d6486e4 commit fea44df

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,26 @@ Frequenz Channels are mostly designed after [Go
2020
channels](https://tour.golang.org/concurrency/2) but it also borrows ideas from
2121
[Rust channels](https://doc.rust-lang.org/book/ch16-02-message-passing.html).
2222

23+
## Quick Start
24+
25+
We assume you are on a system with Python available. If that is not the case,
26+
please [download and install Python](https://www.python.org/downloads/) first.
27+
28+
To install Frequenz Channels, you probably want to create a new virtual
29+
environment first. For example, if you use a `sh` compatible shell, you can do
30+
this:
31+
32+
```sh
33+
python3 -m venv .venv
34+
. .venv/bin/activate
35+
```
36+
37+
Then, just install using `pip`:
38+
39+
```sh
40+
python3 -m pip install frequenz-channels
41+
```
42+
2343
## Contributing
2444

2545
If you want to know how to build this project and contribute to it, please

docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ python3 -m venv .venv
6262

6363
This will create the virtual environment and activate it automatically for you.
6464

65-
Now you can install Frequenz Channels by using `pip`:
65+
Now you can install Frequenz Channels by using `pip` (if you don't have `pip` installed
66+
you can follow [the official instructions](https://pip.pypa.io/en/stable/installation/)):
6667

6768
```sh
6869
python3 -m pip install frequenz-channels

0 commit comments

Comments
 (0)