Skip to content

Commit 4c3ec0e

Browse files
committed
Add quick start section to the README
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 84ebe89 commit 4c3ec0e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@
66

77
A development kit to interact with the Frequenz development platform.
88

9+
## Quick Start
10+
11+
We assume you are on a system with Python available. If that is not the case,
12+
please [download and install Python](https://www.python.org/downloads/) first.
13+
14+
To install the SDK, you probably want to create a new virtual environment first.
15+
For example, if you use a `sh` compatible shell, you can do this:
16+
17+
```sh
18+
python3 -m venv .venv
19+
. .venv/bin/activate
20+
```
21+
22+
Then, just install using `pip`:
23+
24+
```sh
25+
python3 -m pip install frequenz-sdk
26+
```
27+
928
## Contributing
1029

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

0 commit comments

Comments
 (0)