From 5e989d8f83a37de2d3ca13f4f5d6308af98a0091 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Thu, 19 Sep 2024 17:37:19 +0200 Subject: [PATCH] docs: add installation and beta documentation in getting started --- content/docs/getting-started/first-app.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/content/docs/getting-started/first-app.md b/content/docs/getting-started/first-app.md index cf5d3fe5..13df241c 100644 --- a/content/docs/getting-started/first-app.md +++ b/content/docs/getting-started/first-app.md @@ -20,7 +20,13 @@ Let's get started! ## Pub/sub in Zenoh -First, let's write an application, `z_sensor.py` that will produce temperature measurements at each second: +First thing first, we need to install the [zenoh Python library](https://github.com/eclipse-zenoh/zenoh-python). +```bash +pip install eclipse-zenoh==1.0.0b2 +``` +*The examples are updated to use the 1.0 version currently in beta, which is why version must be specified in the installation command. You can find more information about the 1.0 changes in the [migration guides](https://zenoh.io/docs/migration_1.0/concepts/).* + +Then, let's write an application, `z_sensor.py` that will produce temperature measurements at each second: ```python import zenoh, random, time @@ -56,11 +62,12 @@ if __name__ == "__main__": time.sleep(60) ``` -[Install](https://github.com/eclipse-zenoh/zenoh-python) the library and start the subscriber +Start the subscriber: ```bash python3 z_subscriber.py ``` -The subscriber waits for an update on `myhome/kitchen/temp`. +The subscriber waits for an update on `myhome/kitchen/temp`. + Now start `z_sensor.py` as follows ```bash python3 z_sensor.py