forked from johanlindberg/doctest
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
@@ -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. | ||
|
||
|