From 91d298fb04d585010097026f2180f0d74d322f68 Mon Sep 17 00:00:00 2001 From: Karel Burda Date: Mon, 1 Oct 2018 05:45:31 +0200 Subject: [PATCH] Improved README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7e4063b..aac49d2 100644 --- a/README.md +++ b/README.md @@ -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` 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