README.md
# Rclex
**TODO: Add description**
We apologize that documentation in English is still missing.
Please check [README_ja.md](README_ja.md) and [rclex_samples repository](https://github.com/tlk-emb/rclex_samples) for more detail.
## Environment
We tested following versions
- Ubuntu 18.04.4 LTS
- ROS 2 [Dashing Diademata](https://index.ros.org/doc/ros2/Releases/Release-Dashing-Diademata/)
- Elixir 1.9.1-otp-22
- Eralng 22.0.7
Please let us know if you can operate this library with another environment.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `rclex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:rclex, "~> 0.2.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/rclex](https://hexdocs.pm/rclex).