Skip to content

Commit

Permalink
docs: improve wording about shared library in embedding guide
Browse files Browse the repository at this point in the history
  • Loading branch information
vsergeev committed Oct 22, 2020
1 parent cff8158 commit 1bf84fb
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/4.embedding-luaradio.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Embedding LuaRadio

This document describes how to embed LuaRadio into applications, and how
This document describes how to embed LuaRadio into host applications, and how
applications can source or sink samples with LuaRadio flow graphs.

## Table of Contents
Expand All @@ -18,16 +18,17 @@ applications can source or sink samples with LuaRadio flow graphs.
## Introduction

LuaRadio can be run directly from its Lua file sources, but when it is
installed, it is packaged into one dual-purpose binary library called
`libluaradio`.
installed as a shared library, it is packaged into one dual-purpose shared
library called `libluaradio`.

This library can both be loaded as the `radio` package by the LuaJIT
interpreter for scripts, and linked into C/C++ applications to be run via its C
API. The packaged library contains the entire LuaRadio framework, bytecode
compiled, as well as a small C API for creating LuaRadio contexts, loading
scripts with a top-level flow graph, and controlling the top-level flow graph.
This library can both be loaded as the `radio` module by LuaJIT for use in
LuaRadio scripts, as well as linked into C/C++ applications to embed the
LuaRadio engine. The packaged library contains the entire LuaRadio framework,
bytecode compiled, as well as a small C API for creating LuaRadio contexts,
loading scripts with a top-level flow graph, and controlling the top-level flow
graph.

A LuaRadio packaged library installation provides the following:
A LuaRadio packaged shared library installation provides the following:

* `/usr/bin/luaradio` — LuaRadio runner helper script
* `/usr/lib/libluaradio.so` — Shared library for dynamic linking
Expand Down

0 comments on commit 1bf84fb

Please sign in to comment.