aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 7523adb2b989a5528e090bb6defd9a70ba068b6f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
COMPATibility Library for Emacs
===============================
Find here the source for compat.el, a forwards-compatibility library
for (GNU) Emacs Lisp, versions 24.4 and newer.

For information on how to use Compat, please consult the [manual].
The latest state of development can be found in the [snapshot
version].

[manual]:
    https://elpa.gnu.org/packages/doc/compat.html
[snapshot version]:
    https://elpa.gnu.org/devel/doc/compat.html


Source code
-----------
Compat is developed on [GitHub]. The code is mirrored to the [GNU ELPA
repository].

[GitHub]:
    https://github.com/emacs-compat/compat
[GNU ELPA repository]:
    https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/?h=externals/compat


Bug and patches
---------------
Patches, bug reports and comments can be sent via [GitHub].  These may
include issues in the compatibility code, missing definitions or
performance issues.  We also provide a [development mailing list].

[development mailing list]:
    https://lists.sr.ht/~pkal/compat-devel


Contribute
----------
As compat.el is distribed as part of [GNU ELPA], and therefore
requires a [copyright assignment] to the [FSF], for all non-trivial code
contributions.

[GNU ELPA]:
    http://elpa.gnu.org/packages/compat.html
[copyright assignment]:
    https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html
[FSF]:
    https://www.fsf.org/


Distribution
------------
compat.el and all other source files in this directory are distributed
under the [GNU Public License], Version 3 (like Emacs itself).  The manual
(`compat.texi`) is distributed under the [GNU Free Documentation
License], Version 1.3.

[GNU Public License]:
    https://www.gnu.org/licenses/gpl-3.0.en.html
[GNU Free Documentation License]:
    https://www.gnu.org/licenses/fdl-1.3.html