From 285ac282ba19041251964c959f389323518425fc Mon Sep 17 00:00:00 2001 From: Michael Ilyin Date: Tue, 3 Dec 2024 17:27:25 +0100 Subject: [PATCH] long lines cut in readme --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f48cbf9..5661b76 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,9 @@ The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query, and Compute. -Zenoh (pronounced _/zeno/_) unifies data in motion, data at rest, and computations. It carefully blends traditional pub/sub with geo-distributed storage, queries, and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. +Zenoh (pronounced _/zeno/_) unifies data in motion, data at rest, and computations. It carefully blends traditional pub/sub with +geo-distributed storage, queries, and computations, while retaining a level of time and space efficiency that is well beyond any +of the mainstream stacks. Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. @@ -17,9 +19,10 @@ Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.c ## Typescript/Javascript API -This repository provides a Typescript / Javascript binding through the use of the `remote-api-plugin` in this repo. -The long-term plan is to use zenoh [Zenoh written in Rust](https://github.com/eclipse-zenoh/zenoh) to target WASM. -In its current state, it is not possible to compile Zenoh (Rust) to target WASM, and it will need to undergo a fair amount of refactoring before that can happen. +This repository provides a Typescript / Javascript binding through the use of the `remote-api-plugin` in this repo. +The long-term plan is to use zenoh [Zenoh written in Rust](https://github.com/eclipse-zenoh/zenoh) to target WASM. +In its current state, it is not possible to compile Zenoh (Rust) to target WASM, and it will need to undergo a fair +amount of refactoring before that can happen. Docs can be accessed at [Docs Link](https://eclipse-zenoh.github.io/zenoh-ts/) @@ -27,11 +30,16 @@ Docs can be accessed at [Docs Link](https://eclipse-zenoh.github.io/zenoh-ts/) ## How to build and run it -> :warning: **WARNING** :warning: : Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort into maintaining compatibility between the various git repositories in the Zenoh project. +> :warning: **WARNING** :warning: : Zenoh and its ecosystem are under active development. When you build from git, make sure you also +build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git +are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort into maintaining +compatibility between the various git repositories in the Zenoh project. ### Executing the `zenohd` with `zenoh-plugin-remote-api` plugin -The `zenohd` router and its plugins should be built with the same Zenoh sources, the same version of the Rust compiler, and with the same set of features. This requirement exists because the router and plugins share common Rust structures, and Rust doesn't guarantee ABI compatibility of the memory representation of these structures. +The `zenohd` router and its plugins should be built with the same Zenoh sources, the same version of the Rust compiler, and with the +same set of features. This requirement exists because the router and plugins share common Rust structures, and Rust doesn't guarantee +ABI compatibility of the memory representation of these structures. Therefore one of these methods is recommended: