Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
simendsjo committed Mar 11, 2024
1 parent 25bded5 commit 5e460d3
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.org
Original file line number Diff line number Diff line change
@@ -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 [email protected]:simendsjo/sijo-doctest.git ~/quicklisp/local-projects/sijo-doctest
Expand All @@ -10,6 +15,7 @@ Load library
(ql:quickload :sijo-doctest)
#+end_src

** Usage
Write some doctests
#+begin_src lisp
(defun square (x)
Expand All @@ -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.

Expand Down

0 comments on commit 5e460d3

Please sign in to comment.