Skip to content

Commit 5a9aa3f

Browse files
committed
Add some more info to README.
1 parent f0c4932 commit 5a9aa3f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
1+
ABOUT QUICKLISP-PROJECTS
2+
------------------------------------------
13
quicklisp-projects has metadata for Common Lisp projects tracked by
24
Quicklisp. Each subdirectory is named after a project, and a project's
35
subdirectory has a source.txt file describing how to get the project's
46
files. Other metadata files will be added in the future.
57

68
The qlc-meta directory is special, and has files related to creating
79
and updating Quicklisp data.
10+
11+
12+
13+
TO ADD A PROJECT TO QUICKLISP
14+
------------------------------------------
15+
Please open a github issue here:
16+
17+
https://github.com/quicklisp/quicklisp-projects/issues
18+
19+
In the issue, please provide a brief description of what your project
20+
is for and where to fetch its sources.
21+
22+
Your project should include some form of README describing the project
23+
and its purpose.
24+
25+
The system definition(s) for the project should include :DESCRIPTION,
26+
:AUTHOR, and :LICENSE options.
27+
28+
Personal pet peeve: Please don't describe your project simply by
29+
saying it's an interface to some C library. Explain what the C library
30+
is for and why someone might want to use it from Common Lisp, and link
31+
to any useful information about the C library.

0 commit comments

Comments
 (0)