diff options
author | David Bremner <david@tethera.net> | 2015-07-11 17:38:22 +0200 |
---|---|---|
committer | David Bremner <david@tethera.net> | 2015-07-11 17:39:39 +0200 |
commit | 82a2216013af44a82b78fa9c999d4fec1501e3fc (patch) | |
tree | 35a78e81dc6fceb2924c3a533fec3f1bae8f58ca /README.org | |
parent | ef8a6a392da68a56f1e4a64072bf6bcb01dc882d (diff) |
write some basic doc/warnings, and install them
Diffstat (limited to 'README.org')
-rw-r--r-- | README.org | 27 |
1 files changed, 26 insertions, 1 deletions
@@ -1,3 +1,28 @@ * Intro -This is a (so far vapourware) project to generate Debian packages of Emacs Lisp extensions that integrate with the built in (since GNU Emacs 24.1) package system package.el +This is a work-in progress project to generate Debian packages of +Emacs Lisp extensions that integrate with the built in (since GNU +Emacs 24.1) package system package.el. This means that debian packages +built with this tool will show up in M-x list-packages, and that user +installs of more up to date packages will override them (for that +user!). + +* Limitations + +This is currently at the proof of concept stage. It currently deals +only with single file packages, and does not support byte compilation. +The latter limitation may require some coordination with the +emacsen-common maintainer to refine the notion of +"flavours". Package.el currently understands +/usr/share/emacs/site-lisp and /usr/share/emacs/${VERSION}/site-lisp +where VERSION is e.g. 24.5. + +* Usage + +Here is an example of using the helper command (extracted from +debian/rules in this package). + +#+BEGIN_EXAMPLE +override_dh_auto_install: + ./dh_elpa dh-elpa.el $(DESTDIR)/usr/share/emacs/site-lisp/elpa +#+END_EXAMPLE |