github/melpa
1
0
Fork 0
mirror of https://github.com/correl/melpa.git synced 2024-11-26 19:19:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clarify recipe docs, and clean up trailing whitespace in readme.

Browse source
This commit is contained in:
Steve Purcell 2012-04-09 20:41:58 +01:00
parent cae2ac3513
commit 7a78a47302
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -77,8 +77,9 @@ the repository.
Packages are specified by files in the `recipes` directory. You can contribute a new package by adding a new file under `recipes` using the following form, Packages are specified by files in the `recipes` directory. You can contribute a new package by adding a new file under `recipes` using the following form,
(name :url "<repo url>" (name
:fetcher [git|github|svn|darcs|wiki] :fetcher [git|github|svn|darcs|wiki]
[:url "<repo url>"]
[:repo "github-user/repo-name"] [:repo "github-user/repo-name"]
[:files ("<file1>", ...)]) [:files ("<file1>", ...)])
@ -86,10 +87,10 @@ Packages are specified by files in the `recipes` directory. You can contribute
: a lisp symbol that has the same name as the package being specified. : a lisp symbol that has the same name as the package being specified.
`:url` `:url`
: specifies the URL of the version control repository. *not required for the `wiki` fetcher* : specifies the URL of the version control repository. *required for the `git`, `svn` and `darcs` fetchers*
`:fetcher` `:fetcher`
: specifies the type of repository that `:url` points to. Right now package-build supports [git][git], [github][github], [subversion (svn)][svn], [darcs][darcs], and [Emacs Wiki (wiki)][emacswiki] as possible mechanisms for checking out the repository. With the exception of the Emacs Wiki fetcher, package-build uses the corresponding application to update files before building the package. The Emacs Wiki fetcher gets the latest version of the package from `http://www.emacswiki.org/emacs/download/<NAME>.el` where `NAME` is the package name. Note that the `:url` property is not needed for the `wiki` engine unless the name of the package file on the EmacsWiki differs from the package name being built. In the case of the `github` fetcher, use `repo` instead of `url`; the git URL will then be deduced. : specifies the type of repository that `:url` points to. Right now package-build supports [git][git], [github][github], [subversion (svn)][svn], [darcs][darcs], and [Emacs Wiki (wiki)][emacswiki] as possible mechanisms for checking out the repository. With the exception of the Emacs Wiki fetcher, package-build uses the corresponding application to update files before building the package. The Emacs Wiki fetcher gets the latest version of the package from `http://www.emacswiki.org/emacs/download/<NAME>.el` where `NAME` is the package name. Note that the `:url` property is not needed for the `wiki` engine unless the name of the package file on the EmacsWiki differs from the package name being built. In the case of the `github` fetcher, use `:repo` instead of `:url`; the git URL will then be deduced.
`:files` `:files`
: optional property specifying the explicit files used to build the package. Automatically populated by matching all `.el` files in the root of the repository. This is necessary when there are multiple `.el` files in the repository but the package should only be built from a subset. : optional property specifying the explicit files used to build the package. Automatically populated by matching all `.el` files in the root of the repository. This is necessary when there are multiple `.el` files in the repository but the package should only be built from a subset.
@ -149,4 +150,3 @@ This can be configured using the `package-build-archive-dir` variable.
Repositories are checked out to the `working/` directory by default. Repositories are checked out to the `working/` directory by default.
This can be configured using the `package-build-working-dir` variable. This can be configured using the `package-build-working-dir` variable.