Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 77 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Please open a github issue here:
https://github.com/quicklisp/quicklisp-projects/issues

In the issue, please provide a brief description of what your project
is for and where to fetch its sources.
is for and where to fetch its sources in one of the [supported source formats](#supported-sources).

Your project should include some form of README describing the project
and its purpose.
Expand All @@ -37,3 +37,79 @@ Personal pet peeve: Please don't describe your project simply by
saying it's an interface to some C library. Explain what the C library
is for and why someone might want to use it from Common Lisp, and link
to any useful information about the C library.

## Supported Sources

Quicklisp is able to pull code from several kinds of sources. Please see an examples of each provided below.

### branched-git

Points to a specific branch in a Git repo.

*Example:* `branched-git https://gitlab.common-lisp.net/antik/antik.git master`

### darcs

*Example:* `darcs http://dwim.hu/live/hu.dwim.perec/`

### ediware-http

Historical source pointing to software by prolific lisper Edi Weitz. Points to projects hosted in the GitHub profile <https://github.com/edicl/>.

*Example:* `ediware-http chunga`

### http/https/single-file

Points to a single file available at a URL.

This file is expected to be in one of the formats, with accompanying file extension:

* .lisp - Uncompressed single-file lisp source
* .lsp - Uncompressed single-file lisp source
* .tar - Uncompressed tarball
* .tar.gz - Compressed tarball
* .tgz - Compressed tarball
* .zip - ZIP archive

*Example:* `https https://common-lisp.net/project/adw-charting/adw-charting.tar.gz`
*Example:* `single-file http://www.tfeb.org/programs/lisp/memoize.lisp`

### kmr-git

Points to a git repo hosted on <http://git.kpe.io/>.

*Example:* `kmr-git cl-base64`

### latest-github-release

Points to the latest available release on a GitHub project.

*Example:* `latest-github-release https://github.com/Lisp-Stat/array-operations.git`

### latest-github-tag

Points to the latest available tag on a GitHub project.

*Example:* `latest-github-tag https://github.com/sheepduke/chameleon.git`

### latest-gitlab-release

Points to the latest available release in a GitLab repo.

*Example* `latest-gitlab-release https://gitlab.com/daewok/adopt-subcommands.git`

### mercurial

*Example:* `mercurial https://hg.stevelosh.com/adopt`

### git

*Example:* `git https://gitlab.common-lisp.net/alexandria/alexandria.git`

### svn

*Example:* `svn https://svn.common-lisp.net/cl-monad-macros/trunk`

### tagged-git

*Example:* `tagged-git https://github.com/borodust/bodge-blobs-support.git stable`