From 90964a58a67a9473788fb97cd3a17a41765e1991 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Konstantin=20L=C3=A4ufer?= <laufer@cs.luc.edu>
Date: Fri, 6 Sep 2024 12:48:04 -0500
Subject: [PATCH] added readme
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Konstantin Läufer <laufer@cs.luc.edu>
---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..96ba540
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# hello-scalatest-scala
+
+Small project to get started with Scala and ScalaTest.
+
+## Running the main program
+
+```
+$ sbt run
+```
+
+## Running the tests
+
+```
+$ sbt test
+```
+
+or
+
+```
+$ sbt coverage test coverageReport
+```
+
+to see the code coverage percentages of your test suite.
+
+## Running successive tasks with sbt
+
+To speed up the edit-compile-test/run cycle, you can start sbt without arguments
+
+```
+$ sbt
+```
+
+and repeatedly run individual tasks
+
+```
+sbt> run
+```
+
+```
+sbt> test
+```