diff --git a/src/bindings/README.md b/src/bindings/README.md index 08029b1a9a9..9077b12eb4d 100644 --- a/src/bindings/README.md +++ b/src/bindings/README.md @@ -45,6 +45,12 @@ or the The [doc](io/doc/) directory contains an example binding for a fictive asynchronous I/O management library. +## Installation + +See [INSTALL](/doc/INSTALL.md). +A few bindings are part of the core package `libelektra5`. +The package that includes a binding which does not belong to the `libelektra5` package can be found in it's README.md. + ## See Also - See [COMPILE](/doc/COMPILE.md#bindings) for how to specify the bindings to build. diff --git a/src/bindings/cpp/README.md b/src/bindings/cpp/README.md index e9675348c6f..7771021e682 100644 --- a/src/bindings/cpp/README.md +++ b/src/bindings/cpp/README.md @@ -7,6 +7,11 @@ The C++ binding is a 1:1 mapping of all C-functions into C++. In this README the advantages are described. +## Installation + +See [installation](/doc/INSTALL.md). +The package containing the header files is called `libelektra-dev`. + ## No Explicit Delete Necessary The objects will automatically be freed when they leave the scope. E.g. diff --git a/src/bindings/glib/README.md b/src/bindings/glib/README.md index 875791020f7..c3bda241c32 100644 --- a/src/bindings/glib/README.md +++ b/src/bindings/glib/README.md @@ -9,3 +9,8 @@ Provides glib bindings for Elektra. Are used by gsettings and GI bindings. + +## Installation + +See [installation](/doc/INSTALL.md). +This binding is currently **not** part of a released package. diff --git a/src/bindings/gsettings/README.md b/src/bindings/gsettings/README.md index 4670d6bfa7a..edfa8592c22 100644 --- a/src/bindings/gsettings/README.md +++ b/src/bindings/gsettings/README.md @@ -10,6 +10,11 @@ Implementation of Elektra as GSettingsBackend +## Installation + +See [installation](/doc/INSTALL.md). +This binding is currently **not** part of a released package. + ## What is Working: - passing gsettings unit tests diff --git a/src/bindings/io/ev/README.md b/src/bindings/io/ev/README.md index 21f84a40865..af1e12c5039 100644 --- a/src/bindings/io/ev/README.md +++ b/src/bindings/io/ev/README.md @@ -10,6 +10,11 @@ For the purpose of I/O bindings please read the [bindings readme](https://www.libelektra.org/bindings/readme#i-o-bindings). +## Installation + +See [installation](/doc/INSTALL.md). +This binding is currently **not** part of a released package. + ## Requirements - [libev](http://libev.schmorp.de) (4.x; tested with 4.22) diff --git a/src/bindings/io/glib/README.md b/src/bindings/io/glib/README.md index a64a2ef34e2..b9bf79da810 100644 --- a/src/bindings/io/glib/README.md +++ b/src/bindings/io/glib/README.md @@ -10,6 +10,11 @@ For the purpose of I/O bindings please read the [bindings readme](https://www.libelektra.org/bindings/readme#i-o-bindings). +## Installation + +See [installation](/doc/INSTALL.md). +This binding is currently **not** part of a released package. + ## Requirements - glib (version 2.x) diff --git a/src/bindings/io/uv/README.md b/src/bindings/io/uv/README.md index 83ca876aba2..f3ea64b86b5 100644 --- a/src/bindings/io/uv/README.md +++ b/src/bindings/io/uv/README.md @@ -10,6 +10,11 @@ For the purpose of I/O bindings please read the [bindings readme](https://www.libelektra.org/bindings/readme#i-o-bindings). +## Installation + +See [installation](/doc/INSTALL.md). +This binding is currently **not** part of a released package. + ## Requirements - [libuv](http://libuv.org/) (version 1.x is recommended; 0.10 is supported) diff --git a/src/bindings/swig/lua/README.md b/src/bindings/swig/lua/README.md index aaabe604a7d..cd7ecdd01ed 100644 --- a/src/bindings/swig/lua/README.md +++ b/src/bindings/swig/lua/README.md @@ -8,6 +8,11 @@ Lua bindings for Elektra. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `lua-elektra`. + ## Version Should work with Lua 5.1 or later. Iterators need Lua 5.2. diff --git a/src/bindings/swig/python/README.md b/src/bindings/swig/python/README.md index 1e1d2d3c672..6e544bc1671 100644 --- a/src/bindings/swig/python/README.md +++ b/src/bindings/swig/python/README.md @@ -11,6 +11,11 @@ Python bindings for Elektra. If you have the Python bindings already installed, you get started by reading the [tutorial](/doc/tutorials/python-kdb.md). +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `python3-elektra`. + ## CMake Variables To build the Python bindings diff --git a/src/bindings/swig/ruby/README.md b/src/bindings/swig/ruby/README.md index 993021f49c5..c206f7fb498 100644 --- a/src/bindings/swig/ruby/README.md +++ b/src/bindings/swig/ruby/README.md @@ -17,6 +17,11 @@ The two modules provides wrapper classes the C++ interface and are mainly a 1 to 1 mapping. However, to provide a more Ruby-style API, the modules differs to the C++ API in the following way: +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `ruby-elektra`. + ## Ruby `Kdb` Differences to C++ API - C++ iterators for `Key`/`KeySet` are excluded. Instead `KeySet` implements diff --git a/src/plugins/README.md b/src/plugins/README.md index ce339ebfdc0..a83df7b9e3f 100644 --- a/src/plugins/README.md +++ b/src/plugins/README.md @@ -47,6 +47,12 @@ Furthermore, plugins might export symbols: - For information on a plugin use [kdb-plugin-info(1)](/doc/help/kdb-plugin-info.md). - For mount plugin(s) use [kdb-mount(1)](/doc/help/kdb-mount.md). +## Installation + +See [INSTALL](/doc/INSTALL.md). +Many plugins are already part of the core package `libelektra5`. +The package that includes a plugin which does not belong to the `libelektra5` package can be found in it's README.md. + ## See Also For an easy introduction, see [this tutorial how to write a storage plugin](/doc/tutorials/plugins.md).