joelmccracken / elisp-sandbox

A library for elisp sandboxed evaluation
15 stars 5 forks source link

README and emacs-lisp content #10

Open DamienCassou opened 7 years ago

DamienCassou commented 7 years ago

I see you are writing your documentation as a string inside an emacs-lisp program and then generate a README file. If you don't find it convenient, you might want to try the approach used by the buttercup project. This project has some documentation (written in Markdown) containing tests that are both visible as documentation and executable as test suite.

joelmccracken commented 7 years ago

Oh sweet! I like it. If/when I pick this up again I'll experiment.

Sent from my iPhone

On Jul 3, 2017, at 2:31 AM, Damien Cassou notifications@github.com wrote:

I see you are writing your documentation as a string inside an emacs-lisp program and then generate a README file. If you don't find it convenient, you might want to try the approach used by the buttercup project. This project has some documentation (written in Markdown) containing tests that are both visible as documentation and executable as test suite.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.