Skip to content

Commit

Permalink
Improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
Karel Burda committed Oct 1, 2018
1 parent c091423 commit 91d298f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,23 @@ with `--recurse-submodules` or `--recursive` on older versions of git. Alternati
# Introduction
`function_loader` is a header-only library that can find free functions in a shared library and provide and `std::function<T>` wrapper around the found function.

Essentially a wrapper around the calls `LoadLibrary`, `GetProcedure` and `FreeLibrary` system calls on Windows and `dlopen`, `dlsym` and `dlclose` on POSIXes.
Essentially provides wrapper around the calls `LoadLibrary`, `GetProcedure` and `FreeLibrary` system calls on Windows and `dlopen`, `dlsym` and `dlclose` on POSIXes.

Implemented using C++11 for Windows and POSIX systems.
Implemented using C++11.

These exceptions might be thrown:
* `library_load_failed`
* `function_does_not_exist`

See [exceptions.hpp](include/function_loader/exceptions.hpp) for more info.
Exceptions provide additional information about the reason using `what()`, see [exceptions.hpp](include/function_loader/exceptions.hpp) for more info.

# Usage
In order to use the `function_loader`, it's the `include` directory that matters. Just make sure that the header search path is pointing to the [include](include) directory located in the root directory.
On POSIXes, the `libdl` has to be linked to the final executable.

Tou can use the provided package config at [function-loader-config.cmake.in](function-loader-config.cmake.in).
You can use the provided CMake package configuration at [function-loader-config.cmake.in](function-loader-config.cmake.in).

Implementation resides in the `burda::function_loader` namespace, so it might be useful to do `namespace fe = burda::function_loader;` in your project.
Implementation resides in the `burda::function_loader` namespace, so it might be useful to do something like `namespace fe = burda::function_loader;` in your project.

### Example
```cpp
Expand Down

0 comments on commit 91d298f

Please sign in to comment.