Skip to content
This repository
Browse code

Remove commented-out paragraph in README (see #367) and clean up whit…

…espace
  • Loading branch information...
commit 92abe5bf31ad8c27586293b2d8d73748d026004b 1 parent f04a25e
Steve Purcell purcell authored

Showing 1 changed file with 16 additions and 21 deletions. Show diff stats Hide diff stats

  1. +16 21 README.md
37 README.md
Source Rendered
@@ -32,7 +32,7 @@ call to `package-initialize` in your `init.el` file.
32 32
33 33 (add-to-list 'package-archives
34 34 '("melpa" . "http://melpa.milkbox.net/packages/") t)
35   -
  35 +
36 36 Since `package.el` doesn't allow locking packages to certain version,
37 37 we also provide a package `melpa.el` which contains code to allow
38 38 restricting packages to specific repositories. This allows someone to
@@ -52,11 +52,7 @@ guidelines,
52 52 * Upstream source must be stored in an authoritative
53 53 [SCM](http://en.wikipedia.org/wiki/Software_configuration_management)
54 54 repository or on the Emacswiki.
55   -
56   -<!-- * Package must be actively developed and not otherwise included in a -->
57   -<!-- different ELPA archive. Packages that are better suited for -->
58   -<!-- [marmalade](http://marmalade-repo.org/) -->
59   -
  55 +
60 56 * Submit one pull request per recipe. You can create multiple
61 57 branches and create a pull request for each branch.
62 58
@@ -64,16 +60,16 @@ guidelines,
64 60 specifying only files relevant to the package. See the
65 61 [Package Format](#package-format) section for more information on
66 62 specifying package files.
67   -
  63 +
68 64 * The package name should match the name of the feature provided. See
69 65 the `package` function for more information.
70   -
  66 +
71 67 * Packages should adhere to the `package.el` format as specified by
72 68 `(info "(elisp) Packaging")`. More information on this format is
73 69 provided by the
74 70 [marmalade package manual](http://marmalade-repo.org/doc-files/package.5.html).
75   -
76   -
  71 +
  72 +
77 73
78 74 ### Testing
79 75
@@ -86,7 +82,7 @@ Let `<NAME>` denote the name of the recipe to submit.
86 82 3. Confirm your package build properly by running
87 83
88 84 make recipes/<NAME>
89   -
  85 +
90 86 4. Install the file you built by running `package-install-file` from
91 87 within Emacs and specifying the newly built package in the directory
92 88 specified by `package-build-archive-dir` (default: `packages/`
@@ -174,7 +170,7 @@ Since there is only one `.el` file, this package only needs the `:url` and `:fet
174 170 (ido-ubiquitous
175 171 :url "https://github.com/DarwinAwardWinner/ido-ubiquitous.git"
176 172 :fetcher git)
177   -```
  173 +```
178 174
179 175 ### Multiple Packages in one Repository
180 176
@@ -191,7 +187,7 @@ contains the *starter-kit* package along with extra packages in the
191 187 :url "https://github.com/technomancy/emacs-starter-kit.git"
192 188 :fetcher git
193 189 :files ("modules/starter-kit-bindings.el"))
194   -```
  190 +```
195 191
196 192 Notice that `:files` is not specified for `starter-kit` since
197 193 package-build will automatically add all `.el` files in the root
@@ -202,10 +198,10 @@ files specified explicitly.
202 198
203 199 ### Multiple Files in Multiple Directories
204 200
205   -There are special cases when we need
  201 +There are special cases when we need
206 202 There are special cases where creation of the package comes from many
207 203 different sub-directories in the repository and the destination
208   -sub-directories need to be explicitly set.
  204 +sub-directories need to be explicitly set.
209 205
210 206 Consider the `flymake-perlcritic` recipe,
211 207
@@ -230,7 +226,7 @@ first element to be the destination directory. These can be embedded
230 226 further, such as the following---hypothetical---entry for `:files`,
231 227
232 228 ```elisp
233   -("*.el" ("snippets"
  229 +("*.el" ("snippets"
234 230 ("html-mode" "snippets/html-mode/*")
235 231 ("python-mode" "snippets/python-mode/*")))
236 232 ```
@@ -316,17 +312,17 @@ format.
316 312 * `clean-packages` -- remove all compiled packages from the `packages` directory.
317 313
318 314 * `clean-json` -- remove all JSON files.
319   -
  315 +
320 316 Note that these scripts require an Emacs with `package.el` installed,
321 317 such as Emacs 24. If you have an older version of Emacs, you can get a
322 318 suitable `package.el` [here](http://bit.ly/pkg-el23).
323   -
  319 +
324 320 [melpa]: http://melpa.milkbox.net
325 321
326 322
327 323 ## API
328 324
329   -All repository code is contained in the `package-build.el`.
  325 +All repository code is contained in the `package-build.el`.
330 326
331 327 ### Functions
332 328
@@ -397,7 +393,7 @@ which packages will be enabled (whitelist packages only) or excluded
397 393 `package-archives`, PACKAGE is a symbol of a package in that
398 394 archive to exclude. Any specified package is excluded regardless
399 395 of the value of `package-archive-enable-alist`
400   -
  396 +
401 397
402 398 If a particular ARCHIVE has an entry in
403 399 `package-archive-enable-alist` then only packages
@@ -422,4 +418,3 @@ You can install the package manually by pasting this into yoru `*scratch*` buffe
422 418
423 419 *MELPA* is *Milkypostman's ELPA* or *Milkypostman's Experimental Lisp
424 420 Package Archive* if you're not into the whole brevity thing.
425   -

0 comments on commit 92abe5b

Please sign in to comment.
Something went wrong with that request. Please try again.