From 32f5fd8854fbd9ddcc85eda37248c943d1e7f04f Mon Sep 17 00:00:00 2001
From: Paul Romano <paul.k.romano@gmail.com>
Date: Thu, 19 Mar 2020 07:07:32 -0500
Subject: [PATCH] Add README to custom source example

---
 examples/custom_source/README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 examples/custom_source/README.md

diff --git a/examples/custom_source/README.md b/examples/custom_source/README.md
new file mode 100644
index 0000000000..9a22171ae4
--- /dev/null
+++ b/examples/custom_source/README.md
@@ -0,0 +1,14 @@
+# Building a Custom Source
+
+To run this example, you first need to compile the custom source library, which
+requires headers from OpenMC. A CMakeLists.txt file has been set up for you that
+will search for OpenMC and build the custom library. To build the source
+library, you can run:
+
+    mkdir build && cd build
+    OPENMC_ROOT=<path_to_openmc_install> cmake ..
+    make
+
+After this, you can build the model by running `python build_xml.py`. In the XML
+files that are created, you should see a reference to build/libsource.so, the
+custom source library that was built by CMake.