branch: externals/assess commit 880d519d6b1e7202a72b1632733690310efb197f Author: Phillip Lord <phillip.l...@russet.org.uk> Commit: Phillip Lord <phillip.l...@russet.org.uk>
Update readme, add infojs. --- README.md | 25 ++++++++++++++++++++++++- sisyphus-doc.org | 1 + 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b30b709d36..799a72e870 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,30 @@ Sisyphus Sisyphus provides additional support for testing Emacs packages. -It is quite early stages at the moment. +It provides: + - a set of predicates for comparing strings, buffers and file contents. + - explainer functions for all predicates giving useful output + - macros for creating many temporary buffers at once, and for restoring the + buffer list. + - methods for testing indentation, by comparision or "roundtripping". + - methods for testing fontification. + +Sisyphus aims to be a stateless as possible, leaving Emacs unchanged whether +the tests succeed or fail, with respect to buffers, open files and so on; this +helps to keep tests independent from each other. + +Documentation +------------- + +Sisyphus is fully documented using the `lentic-doc` documentation system. + + +Status +------ + +It is now a 0.1 release; for those parts that already exist I do not expected +to change the interface, but it could happen. It is ready for careful use, +therefore. [](https://travis-ci.org/phillord/sisyphus) diff --git a/sisyphus-doc.org b/sisyphus-doc.org index 85668340ab..b19c04e63a 100644 --- a/sisyphus-doc.org +++ b/sisyphus-doc.org @@ -3,5 +3,6 @@ #+AUTHOR: Phillip Lord +#+INFOJS_OPT: view:info toc:nil #+INCLUDE: "sisyphus.org" :lines "28-"