Handle errors file by file instead of returning on first error.

[gnu-emacs-elpa] / README.md

diff --git a/README.md b/README.md
index bc764ba6b807819af689fe315537b6ac0c1baa89..e19fb5a54ee0a1b92edd95bf59f66c7a1c2b9ed1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,20 @@
+<p><a href="http://www.gnu.org/licenses/gpl-3.0.txt"><img src="https://img.shields.io/badge/license-GPL_3-green.svg" alt="License GPL 3" /></a>
+<a href="http://melpa.org/#/async"><img src="http://melpa.org/packages/async-badge.svg" alt="MELPA" title="" /></a>
+<a href="http://stable.melpa.org/#/async"><img src="http://stable.melpa.org/packages/async-badge.svg" alt="MELPA Stable" title="" /></a></p>
+
+

 # emacs-async
 
 `async.el` is a module for doing asynchronous processing in Emacs.
 
 # Install
 
 # emacs-async
 
 `async.el` is a module for doing asynchronous processing in Emacs.
 
 # Install
 

+## Install dired-async
+

 Add to your `.emacs.el`:
 
 Add to your `.emacs.el`:
 

-     (when (require 'dired-aux)
-       (require 'dired-async))
+    (autoload 'dired-async-mode "dired-async.el" nil t)
+    (dired-async-mode 1)

 
 This will allow you to run  asynchronously
 the dired commands for copying, renaming and symlinking.
 
 This will allow you to run  asynchronously
 the dired commands for copying, renaming and symlinking.


@@ -16,8 +23,28 @@ to copy, rename etc... asynchronously from [helm](https://github.com/emacs-helm/
 Note that with [helm](https://github.com/emacs-helm/helm)
 you can disable this by running the copy, rename etc... commands with a prefix argument.
 
 Note that with [helm](https://github.com/emacs-helm/helm)
 you can disable this by running the copy, rename etc... commands with a prefix argument.
 

-If you don't want to make dired/helm asynchronous, you can either
-disable this with `dired-async-be-async` or just load `async.el`.
+If you don't want to make dired/helm asynchronous disable it with `dired-async-mode`.
+
+### Debian and Ubuntu
+
+Users of Debian 9 or later or Ubuntu 16.04 or later may simply `apt-get install elpa-async`.
+
+## Enable asynchronous compilation of your (M)elpa packages
+
+By default emacs package.el compile packages in its running emacs session.
+This is not a problem when installing a new package (which is not actually loaded in current emacs)
+but it may create errors and bad compilation when upgrading a package (old version of package is already loaded
+and running in current emacs).
+You can remedy to this by allowing async to compile your packages asynchronously,
+(helm and magit actually do this by default,
+so if you are using these packages they will compile asynchronously)
+to do this, add to your init file:
+    
+    (async-bytecomp-package-mode 1)
+
+
+You can control which packages will compile async with `async-bytecomp-allowed-packages`.
+Set it to `'(all)` to be sure you will compile all packages asynchronously.

 
 # Usage
 
 
 # Usage