branch: master
commit c25bf17b34a1608da45e8a1ca02e1c89a34acd34
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Document async compilation of packages in README.
---
README.md | 19 +++++++++++++++++++
1 files changed, 19 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
index 7e9e0af..a5b0866 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,8 @@
# Install
+## Install dired-async
+
Add to your `.emacs.el`:
(autoload 'dired-async-mode "dired-async.el" nil t)
@@ -23,6 +25,23 @@ you can disable this by running the copy, rename etc...
commands with a prefix a
If you don't want to make dired/helm asynchronous disable it with
`dired-async-mode`.
+## 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
The interface is intended to be very easy to use:
