From 82a2216013af44a82b78fa9c999d4fec1501e3fc Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sat, 11 Jul 2015 17:38:22 +0200 Subject: write some basic doc/warnings, and install them --- README.org | 27 ++++++++++++++++++++++++++- debian/docs | 1 + 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 debian/docs diff --git a/README.org b/README.org index 56a81ee..375496b 100644 --- a/README.org +++ b/README.org @@ -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 diff --git a/debian/docs b/debian/docs new file mode 100644 index 0000000..f20153b --- /dev/null +++ b/debian/docs @@ -0,0 +1 @@ +README.org -- cgit v1.2.3