Added readme file

emilybache · Oct 6, 2024 · da61be0 · da61be0
1 parent 622b697
commit da61be0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/elisp/readme.org b/elisp/readme.org
@@ -0,0 +1,10 @@
+* Gilded Rose
+Gilded Rose kata in Elisp!
+
+* Structure
+~gilded-rose.el~ contains source code. ~gilded-rose-test.el~ uses [[https://www.gnu.org/software/emacs/manual/html_mono/ert.html][ert]] to run tests
+
+* Running tests
+- Use the command ~eval-buffer~ on ~gilded-rose.el~
+- Use the command ~eval-buffer~ on ~gilded-rose-test.el~
+- Test can be run interactively using the command ~ert~ or with ~(ert-run-tests-interactively t)~