From 5002cdd6ef440fe39e85e939518918abab41cb70 Mon Sep 17 00:00:00 2001 From: vlad0x00 Date: Mon, 11 Apr 2022 15:27:47 -0700 Subject: [PATCH] Update docs --- README.md | 2 +- docs/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 65ffb986..ae38da92 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ For users * `btllib` uses `C++11` features, so that standard should be enabled at a minimum. - Python wrappers * The wrappers correspond one-to-one with C++ code so any functions and classes can be used under the same name. The only exception are nested classes which are prefixed with outer class name (e.g. `btllib::SeqReader::Flag` in C++ versus `btllib.SeqReaderFlag` in Python). - * Use `PYTHONPATH` environment variable or `sys.path.append()` in your Python code to include `/path/to/btllib/install/lib/btllib/python` directory + * Use `PYTHONPATH` environment variable or `sys.path.append()` in your Python code to include `/path/to/btllib/install/lib/btllib/python/btllib` directory * Include the library with `import btllib` - Executables * btllib generated executables can be found in `/path/to/btllib/install/bin` directory. Append that path to the `PATH` environment variable to make it available to your shell. diff --git a/docs/index.html b/docs/index.html index bc8cd503..57f08609 100644 --- a/docs/index.html +++ b/docs/index.html @@ -108,7 +108,7 @@

  • Python wrappers
    • The wrappers correspond one-to-one with C++ code so any functions and classes can be used under the same name. The only exception are nested classes which are prefixed with outer class name (e.g. btllib::SeqReader::Flag in C++ versus btllib.SeqReaderFlag in Python).
    • -
    • Use PYTHONPATH environment variable or sys.path.append() in your Python code to include /path/to/btllib/install/lib/btllib/python directory
    • +
    • Use PYTHONPATH environment variable or sys.path.append() in your Python code to include /path/to/btllib/install/lib/btllib/python/btllib directory
    • Include the library with import btllib