enrich README #24

takasehideki · 2024-02-21T08:58:41Z

READMEをかき揚げてみました！
変なことを書いてないか確認してもらいたいです．ツッコミ大歓迎です！ > @pojiro @s-hosoai

takasehideki · 2024-02-21T08:59:20Z

README.md


-Zenohex is the [zenoh](https://zenoh.io/) client library for elixir.
+Zenohex is Elixir API for [Zenoh](https://zenoh.io/).


zenoh-pythonなど他のライブラリもこのような書き方（e.g. Python API for Zenoh）なので合わせました．

takasehideki · 2024-02-21T09:01:01Z

README.md

+Zenoh is a new protocol for Zero Overhead Pub/Sub, Store/Query and Compute.
+The most obvious explanation is that Zenoh offers publication subscription-based communication capabilities.
+Within the same network, Zenoh can autonomously search for communication partner nodes like DDS.
+Between different networks, Zenoh can search for nodes through a broker (called a router in Zenoh) like MQTT.
+Also, Zenoh provides functions for database operations and computational processing based on the Key-Value Store.
+Moreover, it has plugins/bridges for interoperability with MQTT, DDS, REST, etc. as communication middleware, and influxdb, RocksDB, etc. as database stacks.

-## Installation
+For more details about Zenoh, please refer to the official resources.
+- [Official Page](https://zenoh.io/)
+- [GitHub](https://github.com/eclipse-zenoh/zenoh)
+- [Discord](https://discord.gg/vSDSpqnbkm)

-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `zenohex` to your list of dependencies in `mix.exs`:
+Zenoh's core modules are implemented in Rust, but API libraries in various programming languages such as Python ([zenoh-python](https://github.com/eclipse-zenoh/zenoh-python)), C ([zenoh-c](https://github.com/eclipse-zenoh/zenoh-c)), C++ ([zenoh-cpp](https://github.com/eclipse-zenoh/zenoh-cpp)) are officially provided.

-```elixir
-def deps do
-  [
-    {:zenohex, "~> 0.2.0-rc.2"}
-  ]
-end
-```
+So what we need is [Elixir](https://elixir-lang.org/)!
+With this library, you can call Zenoh from your Elixir application to perform its basic processing.
+This allows the creation and communication of a large number of fault-tolerant nodes with little memory load (we hope :D


ちょっと前置きとしては長いんですが,,, 初めてこれを見る alchemist に Zenoh への興味を惹いてもらうために,,,:D

README.md

takasehideki · 2024-02-21T09:02:56Z

README.md

-## Getting Started
+This repository uses [Rustler](https://github.com/rusterlium/rustler) to call Rust (Zenoh) modules from Elixir, and pre-compiled NIF modules are automatically downloaded at `mix compile` time (since v0.1.3). 
+IOW, if you just want to use this library from your Elixir application, you do not need to prepare a Rust environment.
+If you still want to build Rust NIF modules locally, please refer to [this section](#build-nif-module-locally).


元のだと [optional] を見逃すと Rust が必要そうに読めなくもなかったので，ちょっと明確化しました．

takasehideki · 2024-02-21T09:03:19Z

README.md

+
+Zenohex has a policy of providing APIs that wrap the basic functionality of Zenoh like other API libraries.
+
+Here is the first step to building an Elixir application and using this feature.


このライブラリの方針を明確化しつつ，これは簡単な例だよってことにしました．

takasehideki · 2024-02-21T09:05:07Z

README.md

 {:ok, #Reference<>}
-iex(3)> {:ok, subscriber} = Zenohex.Session.declare_subscriber(session, "pub/sub")
+iex()> {:ok, subscriber} = Zenohex.Session.declare_subscriber(session, "demo/**")


key名はいちばん使ってそうな Examples 例に合わせることにしました
https://github.com/eclipse-zenoh/zenoh-python/tree/master/examples#z_pub

takasehideki · 2024-02-21T09:05:48Z

README.md

-{:ok, "Hello Zenoh Dragon"}
-iex(6)> Zenohex.Subscriber.recv_timeout(subscriber, 1000)
+iex()> Zenohex.Subscriber.recv_timeout(subscriber, 1000)
+{:ok,
+ %Zenohex.Sample{
+   key_expr: "demo/example/test",
+   value: "Hello Zenoh Dragon",
+   kind: :put,
+   reference: #Reference<>
+ }}


これ私の環境ではこのように出力されましたが，意図として合っていたでしょうか？

あってます！途中でデータそのまま（integer, float, binary）を返すだけでは設計が成り立たないことが分かって、Sample 構造体を返すようにしました。私の範囲での README.md の修正し忘れです 🙇

takasehideki · 2024-02-21T09:06:17Z

README.md

+
+For most users, this section should be skipped.
+
+### Build NIF module locally


自分でNIFコンパイルしたい方向けの情報はこのセクションにまとめました

takasehideki · 2024-02-21T09:06:56Z

README.md

+  end
+```
+
+### Enhance mix test


mix testに関するTIPS的なところをここにまとめました．
いちばん自信がないので特に確認いただきたいです！ > @pojiro

ばっちり、問題なしです。

takasehideki · 2024-02-21T09:07:24Z

README.md


 ### How to release

+These steps just follow the [Recommended flow of rustler_precompiled](https://hexdocs.pm/rustler_precompiled/precompilation_guide.html#recommended-flow).


このセクションのバージョン番号は都度で更新したくないので，もう v0.2.0 ってことにしました．

takasehideki

いろいろ補足を入れました！

pojiro

内容はすばらしくて特に指摘事項はありません。

それと別で見つけた些末な修正提案を出しています。

README.md

Co-authored-by: Ryota Kinukawa <[email protected]>

pojiro

zenohex_on_nerves の中身を作ることを約束。

README.md

Co-authored-by: Ryota Kinukawa <[email protected]>

takasehideki · 2024-02-22T01:36:40Z

README.md

+USE_DIFFERENT_SESSION="1" mix test
+```
+
+FYI, CI does this in `test-with-another-session` without defining `SCOUTING_DELAY`, so this test sometimes fails on GHA.


@pojiro CIが実際に落ちることがあるので aaad576 にて注記しました（自分が忘れないために:D
https://github.com/b5g-ex/zenohex/actions/runs/7997846597/job/21843046901

"without defining SCOUTING_DELAY" だと思っていましたが，合っていたでしょうか？

USE_DIFFERENT_SESSION="1" の場合、SCOUTING_DELAY が短いより長い方が落ちにくくなるのは事実。
だけど、長くても（デフォルトの200ms としても）落ちる時があるというのが私の感触です。

ありがとうございます！説明文としては間違っていない（SCOUTING_DELAYは定義していない）と認識しました．
ここで言いたかったことは test-with-another-session だけ落ちることあるけどトランキーロだぜっという自分たち向けのメモなので，不足ないということにします！

なにかが足りてない,,, と思ったら SCOUTING_DELAY のデフォルト値が抜けてました．ので 78ac00b にて追加しました！

s-hosoai

ありがとうございます！変更箇所と全体を見直しましたが，とてもええ感じです！

pojiro · 2024-02-22T04:41:17Z

README.md

+USE_DIFFERENT_SESSION="1" mix test
+```
+
+FYI, CI does this in `test-with-another-session` without defining `SCOUTING_DELAY`, so this test sometimes fails on GHA.


Suggested change

FYI, CI does this in `test-with-another-session` without defining `SCOUTING_DELAY`, so this test sometimes fails on GHA.

FYI, CI does this in `test-with-another-session` without defining `SCOUTING_DELAY`.

This test may fails on GHA, it depends on whether the scouting is successful or not.

落ちることもあるというニュアンスを残す文章にするならこうはどうでしょう？

一足遅かった笑、🆗

ごめんなさい！これ merge しちゃったのでこっちに移動させます！（もうひとつ修正漏れもあったので,,,
#25

takasehideki added 6 commits February 21, 2024 15:42

add status badge for CI

a3918d7

add introduction about Zenoh and its repo

3294b84

add description for installation

74eb00e

add usage as getting started

ae41d1b

add note for developers (very welcome!!)

2c699f3

add resources and license info

9132eb2

takasehideki requested review from s-hosoai and pojiro February 21, 2024 08:58

takasehideki commented Feb 21, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

takasehideki commented Feb 21, 2024

View reviewed changes

pojiro suggested changes Feb 21, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

takasehideki and others added 4 commits February 22, 2024 10:01

fix typo

dd5d1d1

Co-authored-by: Ryota Kinukawa <[email protected]>

add period to unify another items

dbbd37b

Co-authored-by: Ryota Kinukawa <[email protected]>

del unnecessory space

eff55fa

Co-authored-by: Ryota Kinukawa <[email protected]>

add blank line to enrich md format

ad40044

Co-authored-by: Ryota Kinukawa <[email protected]>

pojiro suggested changes Feb 22, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

pojiro self-requested a review February 22, 2024 01:28

takasehideki and others added 2 commits February 22, 2024 10:32

update link to reference implementation of usage on Nerves

cd2a4db

Co-authored-by: Ryota Kinukawa <[email protected]>

enhance note about CI on GHA

aaad576

takasehideki commented Feb 22, 2024

View reviewed changes

s-hosoai approved these changes Feb 22, 2024

View reviewed changes

add note about default value of SCOUTING_DELAY

78ac00b

takasehideki merged commit cd6678b into main Feb 22, 2024
4 checks passed

takasehideki deleted the readme branch February 22, 2024 04:39

pojiro reviewed Feb 22, 2024

View reviewed changes

takasehideki restored the readme branch February 22, 2024 04:42

takasehideki added a commit that referenced this pull request Feb 22, 2024

re-enrich in response to #24 (comment)

5267e9d

takasehideki mentioned this pull request Feb 22, 2024

re-enrich README (before releasing v0.2.0) #25

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

enrich README #24

enrich README #24

takasehideki commented Feb 21, 2024

takasehideki Feb 21, 2024

takasehideki Feb 21, 2024

takasehideki Feb 21, 2024

takasehideki Feb 21, 2024

takasehideki Feb 21, 2024

takasehideki Feb 21, 2024

pojiro Feb 21, 2024

takasehideki Feb 21, 2024

takasehideki Feb 21, 2024

pojiro Feb 21, 2024

takasehideki Feb 21, 2024

takasehideki left a comment •

edited

Loading

pojiro left a comment

pojiro left a comment

takasehideki Feb 22, 2024

takasehideki Feb 22, 2024

pojiro Feb 22, 2024

takasehideki Feb 22, 2024

takasehideki Feb 22, 2024

s-hosoai left a comment

pojiro Feb 22, 2024

pojiro Feb 22, 2024

takasehideki Feb 22, 2024


		Zenohex is the [zenoh](https://zenoh.io/) client library for elixir.
		Zenohex is Elixir API for [Zenoh](https://zenoh.io/).


		Zenohex has a policy of providing APIs that wrap the basic functionality of Zenoh like other API libraries.

		Here is the first step to building an Elixir application and using this feature.


		For most users, this section should be skipped.

		### Build NIF module locally


		### How to release

		These steps just follow the [Recommended flow of rustler_precompiled](https://hexdocs.pm/rustler_precompiled/precompilation_guide.html#recommended-flow).

	FYI, CI does this in `test-with-another-session` without defining `SCOUTING_DELAY`, so this test sometimes fails on GHA.
	FYI, CI does this in `test-with-another-session` without defining `SCOUTING_DELAY`.
	This test may fails on GHA, it depends on whether the scouting is successful or not.

enrich README #24

enrich README #24

Conversation

takasehideki commented Feb 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takasehideki left a comment • edited Loading

Choose a reason for hiding this comment

pojiro left a comment

Choose a reason for hiding this comment

pojiro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s-hosoai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takasehideki left a comment •

edited

Loading