From 7a2e60d877950387548a856612c3c50f194a6791 Mon Sep 17 00:00:00 2001
From: Ron Hough <ron@smokedramen.net>
Date: Sat, 11 Mar 2023 14:14:18 -0600
Subject: [PATCH] wip

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index dc0dac7..b9dd9f7 100644
--- a/README.md
+++ b/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
+```