Update development workflow in README

Author: Matthieu Longo

README.md

@@ -53,82 +53,71 @@ such links in HTTP headers with the "Link:" header field.
     std::cout << links[1].linkTarget << std::endl; // https://example.org/a/other
 ```
 
-## Building
-
-`http-link-header-cpp` is a header-only C++11 library. Building can be done with cmake >= 3.1 and has been tested with g++ and clang compilers. 
-
-`http-link-header-cpp` uses a pretty standard cmake build system. After cloning the repository, execute the following:
-
-```shell
-cd http-link-header-cpp
-mkdir build
-cd build
-cmake ..
-cmake --build . --config Release
-```
-
-You can also run all the tests:
-
-```shell
-make test
-```
-
 ## Dependencies
 
-`http-link-header-cpp` has a dependency on [uriparser](https://github.com/uriparser/uriparser/)
-which it uses when resolving URI references. Any project using `http-link-header-cpp` should also be able to find a copy of
-uriparser. uriparser should either be installed locally or included within the the project's code.
+### Build dependencies / runtime dependencies
+- [uriparser](https://github.com/uriparser/uriparser/): used when resolving URI references.
 
-## Installing
+### Test dependencies
+- [doctest](https://github.com/doctest/doctest): used in the unit tests.
 
-`http-link-header-cpp` will install its header file, `http-link-header.h`, and a few cmake helper files that can be used by other
-projects to find and use `http-link-header-cpp`.
+## Development pre-requisites
 
-The default installation locations for `http-link-header-cpp` are `/usr/local/include` and `/usr/local/share`.
+1. Install a toolchain. `http-link-header-cpp` is a header-only C++11 library. You will need a recent GCC or Clang compiler supporting fully C++17 at least.
+2. Install CMake.
+3. Install Python.
+4. Install conan: `python3 -m pip install -U conan` (more details at [docs.conan.io](https://docs.conan.io/en/latest/index.html))
+ - run `conan` once to initialize conan home (`~/.conan`)
+ - create a conan profile for the default system compiler
 
-To install using cmake after building and testing, execute the following:
+## Development workflow
 
-```shell
-cmake --build . --config Release --target install
+After cloning the repository, create a build directory at the root of the package.
+```txt
+mkdir build-dir && cd build-dir
 ```
 
-You should see output similar to:
-
-```shell
--- Installing: /usr/local/share/http-link-header-cpp/cmake/http-link-headerTargets.cmake
--- Installing: /usr/local/share/http-link-header-cpp/cmake/http-link-headerConfig.cmake
--- Installing: /usr/local/share/http-link-header-cpp/cmake/http-link-headerConfigVersion.cmake
--- Installing: /usr/local/include/http-link-header.h
+Pull the dependencies with Conan.
+```txt
+conan install --build=missing ..
 ```
 
-If you want the files to be installed somewhere different, you can set the installation prefix when running the initial cmake command. For example:
-
+Generate the build scripts with `cmake`.
 ```shell
-cmake -DCMAKE_INSTALL_PREFIX:PATH=/tmp/http-link-header-cpp-install ..
-cmake --build . --config Release --target install
+cmake -DUSE_CONAN=ON \
+      -GNinja \
+      -DCMAKE_PREFIX_PATH=$(pwd) \
+      -DCMAKE_BUILD_TYPE=Release \
+      -DCMAKE_INSTALL_PREFIX=$(pwd)/sysroot \
+      .. # the directory containing the conanfile.txt
 ```
-
-## Using http-link-header-cpp
-
-### After installing
-
-Once `http-link-header-cpp` is installed, you can use it in your project with a simple cmake `find_package()` command. Be
-sure to mark it as using `CONFIG` mode since we just installed those config files. Also mark it as required if your
-project requires `http-link-header-cpp`.
-
-```shell
-find_package("http-link-header-cpp" CONFIG REQUIRED)
+Explanations:
+- `-DUSE_CONAN=ON`: tell `CMakeLists.txt` to load `conanbuildinfo.cmake` generated by the `conan install` command.
+- `-GNinja`: Use Ninja instead of GNU Make. Remove this if you prefer using GNU Make as it is the default CMake generator.
+- `-DCMAKE_PREFIX_PATH=$(pwd)`: Variable telling CMake where to find the generated config files for dependencies (i.e. `<lowercasePackageName>-config.cmake`)
+- `-DCMAKE_BUILD_TYPE=Release`: Change it to `Debug` if you want to build the project with `-O0 -g`
+- `-DCMAKE_INSTALL_PREFIX=$(pwd)/sysroot`: If `CMAKE_INSTALL_PREFIX` is not set, the default installation locations for `http-link-header-cpp` are `/usr/local/include` and `/usr/local/share`.
+
+Build the project.
+```txt
+ninja
 ```
 
-### Not installing
+Run the unit tests.
+```txt
+ninja test
+```
 
-You can use `http-link-header-cpp` in your project without installing it at all. This will require a little more
-configuration.
+Install the build artifacts.
+```txt
+ninja install
+```
 
-Once you put the `http-link-header-cpp` files somewhere (likely within your own project), then you use
-cmake's `add_subdirectory()`. You will want to make sure not to install `http-link-header-cpp` during your install process
-by using the `EXCLUDE_FROM_ALL` option.
+## Exporting the package into Conan cache
 
+At the root of the package:
 ```shell
-add_subdirectory(path/to/http-link-header-cpp ${PROJECT_BINARY_DIR}/http-link-header-cpp-build EXCLUDE_FROM_ALL)
+conan create . http-link-header-cpp/0.9.0@conan/testing --build=missing
 ```
+
+The package can be pulled in others packages depending on it by adding `http-link-header-cpp/0.9.0@conan/testing` as a build dependency.