diff --git a/README.org b/README.org index f475577..346ab2e 100644 --- a/README.org +++ b/README.org @@ -1,5 +1,10 @@ -Doctests for Lisp +[[https://github.com/simendsjo/sijo-doctest/actions/workflows/tests.yaml/badge.svg][Build]] +* Doctests for Lisp + +See [[file:CHANGELOG.org][CHANGELOG]]. + +** Installation Clone repository #+begin_src bash git clone git@github.com:simendsjo/sijo-doctest.git ~/quicklisp/local-projects/sijo-doctest @@ -10,6 +15,7 @@ Load library (ql:quickload :sijo-doctest) #+end_src +** Usage Write some doctests #+begin_src lisp (defun square (x) @@ -29,7 +35,7 @@ Test your package (sijo-doctest:test-package :your-own-package) #+end_src -* Documentation for ~sijo-doctest::test~ +** Documentation for ~sijo-doctest::test~ Warning: This is bound to get out of date, so look at the documentation in the source.