Skip to content

Commit 3fde3c8

Browse files
committed
Update docs
1 parent 67819fe commit 3fde3c8

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

docs/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@ libcarna-python
44
These are the Python bindings for the LibCarna library. The documentation of the original LibCarna library can be found at:
55
https://kostrykin.github.io/LibCarna/html.
66

7+
8+
Getting Started
9+
---------------
10+
11+
The easiest way to install and use the library is to use our pre-built
12+
`Conda <https://www.anaconda.com/docs/getting-started/miniconda>`_ packages::
13+
14+
conda install bioconda::libcarna-python
15+
16+
To get started, it is best to consider our `Examples`_ below.
17+
18+
.. note::
19+
If you encounter an error similar to `"Failed expression: pimpl->eglDpy != EGL_NO_DISPLAY"`, then you must install
20+
an EGL implementation suitable for your rendering hardware. For example, on Ubuntu Linux, ``sudo apt install
21+
libegl1`` installs a meta package that automatically chooses the right implementation, or ``libegl-mesa0`` for
22+
software rendering.
23+
724
Examples
825
--------
926

linux_build.bash

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ conda activate "$ROOT"/.env
1616
# Create build directory
1717
mkdir -p "$ROOT"/build
1818

19-
# Build native extension
19+
# Configure build
2020
cd "$ROOT"/build
2121
cmake -DCMAKE_BUILD_TYPE=Release \
2222
-DPYTHON_EXECUTABLE="$(which python)" \
2323
-Dpybind11_DIR="$CONDA_PREFIX/share/cmake/pybind11" \
2424
-DCMAKE_MODULE_PATH="$CONDA_PREFIX/share/cmake/Modules" \
2525
"$ROOT"
26+
27+
# Build native extension
2628
if [ -z "$LIBCARNA_SKIP_NATIVE" ]; then
2729
make VERBOSE=1
2830
fi

0 commit comments

Comments
 (0)