Distributing CL source code?
Posted: Tue Jul 12, 2011 6:27 am
Hello. I don't have anything to *surprise* the humanity yet but I think it would be a good practice to organize the project in a way it is common for other people to do.
So, say and I wanted to provide source code to someone and some means of compiling it and testing, how would I do that? What am I expected to do myself, and what should I leave for others, who potentially may use my code?
So, for example, if the project is supposed to compile to binaries, I'd have to have a build script, what are the conventions? Do I have to add a .make file? Shell scripts? Ant? When installing with asdf-install I remember that some libraries provided a way to test them immediately after they are installed - I think this is a very good idea, but how would I do that?
How much documentation is considered *good enough*? Is there a documentation compiler (a program that would collect variables, functions, classes etc and their documentations and produce HTML / man / info / whatever other format)?
Is there an example project, you could point finger and tell it's just as everyone would expect a normal CL project to be? (at googlecode / github)
Thanks!
So, say and I wanted to provide source code to someone and some means of compiling it and testing, how would I do that? What am I expected to do myself, and what should I leave for others, who potentially may use my code?
So, for example, if the project is supposed to compile to binaries, I'd have to have a build script, what are the conventions? Do I have to add a .make file? Shell scripts? Ant? When installing with asdf-install I remember that some libraries provided a way to test them immediately after they are installed - I think this is a very good idea, but how would I do that?
How much documentation is considered *good enough*? Is there a documentation compiler (a program that would collect variables, functions, classes etc and their documentations and produce HTML / man / info / whatever other format)?
Is there an example project, you could point finger and tell it's just as everyone would expect a normal CL project to be? (at googlecode / github)
Thanks!