wip

README.md

@@ -1 +1,14 @@
-A basic C++ exercise.
+A basic C++ exercise which uses `conan` to satisfy dependencies before building a shared library and
+an executable that links it.  Also produces a `.deb` package which installs the executable, library,
+and public headers.
+
+## Prerequisites
+* Ubuntu 22.04 (or equivalent)
+* Python3 venv support installed (i.e. `sudo apt install python3-venv`)
+
+## Setup
+Create a `python` virtual environment and install `conan`:
+```bash
+python3 -m venv conan.venv
+source conan.venv/bin/activate
+```