Expand README

Author: globberwops

README.md

@@ -22,11 +22,13 @@ Try DynamicLoader in [Compiler Explorer](https://godbolt.org/z/KvGxYhErh).
 * Linux only
 * Does not support function overloads in the loaded library
 
-## Usage
+## Example
 
 ```C++
+#include <DynamicLoader/DynamicLoader.hpp>
+
 try {
-  auto dynamic_loader = DynamicLoader{"<path/to/lib>"};
+  auto dynamic_loader = dl::DynamicLoader{"<path/to/lib>"};
   auto mangled_name = dynamic_loader.Mangle("Square");
   auto function = dynamic_loader.Lookup<int(int)>(mangled_name);
   assert(function(2) == 4);
@@ -37,10 +39,83 @@ try {
 
 ## Configuration options
 
-| Name                          | Description                                                           |
-|-------------------------------|-----------------------------------------------------------------------|
-| DynamicLoader_BUILD_DOCS      | Build the documentation (requires [Doxygen](https://www.doxygen.nl/)) |
-| DynamicLoader_BUILD_TESTS     | Build the tests                                                       |
-| DynamicLoader_ENABLE_WARNINGS | Enable compiler warnings                                              |
+| Name                               | Description                      | Default                   |
+|------------------------------------|----------------------------------|---------------------------|
+| `DynamicLoader_BUILD_DOCS`         | Build the documentation          | `$PROJECT_IS_TOP_LEVEL`   |
+| `DynamicLoader_BUILD_TESTS`        | Build the tests                  | `$PROJECT_IS_TOP_LEVEL`   |
+| `DynamicLoader_ENABLE_WARNINGS`    | Enable compiler warnings         | `$PROJECT_IS_TOP_LEVEL`   |
+| `DynamicLoader_CONFIG_INSTALL_DIR` | Install path for package configs | `lib/cmake/DynamicLoader` |
+
+## Building
+
+DynamicLoader uses the [CMake](https://cmake.org/) build system, and [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) for its (optional) dependencies.
+You need CMake >= 3.24.0, Clang >= 12, or GCC >= 9 to build the library.
+
+```Bash
+cmake -B build [-GNinja] [-DCMAKE_BUILD_TYPE=Release]
+cmake --build build [--config Release]
+cmake --install build [--config Release] [--prefix build/prefix]
+```
+
+## Testing
+
+DynamicLoader uses [CTest](https://cmake.org/cmake/help/latest/manual/ctest.1.html) and [doctest](https://github.com/doctest/doctest) for its unit tests.
+
+```Bash
+cd build
+ctest [-C Release]
+```
+
+## Documentation
+
+DynamicLoader uses [Doxygen](https://www.doxygen.nl/) and [Doxygen Awesome](https://github.com/jothepro/doxygen-awesome-css) for its documentation.
+
+```Bash
+cmake --build build --target DynamicLoaderDocs
+```
+
+Please find the HTML documentation in `build/docs/html`
 
-Uses [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake), [doctest](https://github.com/doctest/doctest), and [Doxygen Awesome](https://github.com/jothepro/doxygen-awesome-css).
+## Usage
+
+DynamicLoader can be integrated in your project in several ways.
+
+### CMake FetchContent
+
+```CMake
+include(FetchContent)
+FetchContent_Declare(
+  dynamic-loader
+  GIT_REPOSITORY https://github.com/globberwops/dynamic-loader.git
+  GIT_TAG <tag>
+)
+FetchContent_MakeAvailable(dynamic-loader)
+...
+target_link_libraries(<your-target> PRIVATE DynamicLoader::DynamicLoader)
+```
+
+### Git submodules
+
+```Bash
+git submodule add https://github.com/globberwops/dynamic-loader.git third_party/dynamic-loader
+cd third_party/dynamic-loader
+git checkout <tag>
+```
+
+```CMake
+add_subdirectory(third_party/dynamic-loader EXCLUDE_FROM_ALL)
+...
+target_link_libraries(<your-target> PRIVATE DynamicLoader::DynamicLoader)
+```
+
+### Vcpkg
+
+```Bash
+vcpkg install dynamic-loader
+```
+
+```CMake
+find_package(DynamicLoader CONFIG REQUIRED)
+...
+target_link_libraries(<your-target> PRIVATE DynamicLoader::DynamicLoader)
+```