Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vlad0x00 committed Apr 11, 2022
1 parent d9a001f commit 5002cdd
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h2><a class="anchor" id="autotoc_md4"></a>
</li>
<li>Python wrappers<ul>
<li>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. <code><a class="el" href="structbtllib_1_1SeqReader_1_1Flag.html">btllib::SeqReader::Flag</a></code> in C++ versus <code>btllib.SeqReaderFlag</code> in Python).</li>
<li>Use <code>PYTHONPATH</code> environment variable or <code>sys.path.append()</code> in your Python code to include <code>/path/to/btllib/install/lib/btllib/python</code> directory</li>
<li>Use <code>PYTHONPATH</code> environment variable or <code>sys.path.append()</code> in your Python code to include <code>/path/to/btllib/install/lib/btllib/python/btllib</code> directory</li>
<li>Include the library with <code>import btllib</code></li>
</ul>
</li>
Expand Down

0 comments on commit 5002cdd

Please sign in to comment.