m-buffer-el icon indicating copy to clipboard operation
m-buffer-el copied to clipboard

Doc: add a simple example

Open vindarel opened this issue 9 years ago • 3 comments

"because the doc is too scarce and we can't see the lentic generated one."

Hi, I struggled for too many minutes with code, ielm and edebug before finding this simple example, so here it is. This library is handy, let's show it ! Let me know if you need something about copyright.

Cheers !

vindarel avatar Jul 10 '16 12:07 vindarel

Sounds good. I should put a longer tutorial at the beginning.

Do you have copyright assignment with the FSF? m-buffer is probably going to go into core soonish, and I'll need that.

Out of curiosity, did you try the lentic doc? Feedback is welcome.

phillord avatar Jul 11 '16 09:07 phillord

No, I have no copyright assignment with the FSF. What shall I do ? (I read your link; besides this is a really small change) And no, didn't go to try Lentic and I'm discouraged right now because it's undocumented too :p what's the starting point ? (do you plan to host the doc somewhere ? github pages would be easy)

ps: cool news and congrats for m-buffer going into core

vindarel avatar Jul 11 '16 09:07 vindarel

Do you want to send me an email, and I'll send you the copyright instructions (my email is in the source).

Lentic is documented with itself, which I realise is a bit of a chicken-and-egg thing. The documentation is linked from the readme. http://homepages.cs.ncl.ac.uk/phillip.lord/lentic/lenticular.html

You should be able to go M-x package-install lentic-server and then "M-x lentic-server-browse`, in your Emacs. If m-buffer is loaded, you can browse the documentation from there.

I'll look at checking the doc directly into the repo.

phillord avatar Jul 11 '16 13:07 phillord