didierverna / declt

Reference manual generator for Common Lisp libraries
Other
38 stars 6 forks source link

Add a README and small examples #1

Closed joaotavora closed 6 years ago

joaotavora commented 10 years ago

Hi,

I've been perusing your site, common-lisp.net the code and github itself and I would really like to see a small example of DECLT's capabilities in order to decide and or convince coworkers to use it.

The user manual, README or other introductory materials don't seem to have "easy new-york teenage" examples (see http://weitz.de/hunchentoot/#start for the reference).

Can you quickly flesh out this template to make it a real example? Then can you add this to README.md and/or the user manual?

Quick start

To get started with DECLT write in foo.lisp

(defpackage :thingy)
(in-package :thingy)

(defun foo (bar) 
   "Frobnicates BAR. 

Also takes care of BAZ."

And then run:

CL-USER> (whatever needs to be run)

Find your glorious reference manual here place/where/reference/manual/now/lives

didierverna commented 6 years ago

Hello, I've improved the README file to answer your request.

joaotavora commented 6 years ago

And it only took you 4 years!!! I'm kidding, thanks. It looks great.

didierverna commented 6 years ago

4 years is not a lot. I believe my international world record is... 14 years :-O

joaotavora commented 6 years ago

That would have been epic, really epic in the ancient Greek sense. Just 6 short of Odysseus! But I don't believe you :)

On Wed, Jun 20, 2018, 10:15 Didier Verna notifications@github.com wrote:

4 years is not a lot. I believe my international world record is... 14 years :-O

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/didierverna/declt/issues/1#issuecomment-398681596, or mute the thread https://github.com/notifications/unsubscribe-auth/AAXnw3SFBhw-y_UF0YUZNPExaOqJjhyBks5t-hKpgaJpZM4B83pS .