aboutsummaryrefslogtreecommitdiff
path: root/samples/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'samples/README.md')
-rw-r--r--samples/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/samples/README.md b/samples/README.md
new file mode 100644
index 0000000..d51b9c2
--- /dev/null
+++ b/samples/README.md
@@ -0,0 +1,3 @@
+This directory contains fully functional application examples of akka-serial. To run an example, change to the base directory of akka-serial (this parent's directory) and run `sbt samples<SampleName>/run`.
+
+All projects, including samples, can be listed by running `sbt projects`.