Skip to content

Commit 896e936

Browse files
committed
Add a README.md to keep things pretty on GitHub
1 parent e18751a commit 896e936

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
config-package-dev
2+
===
3+
4+
config-package-dev is a tool for building Debian _configuration
5+
packages_, that is, packages that configure other Debian packages
6+
already on your system. It is an alternative to configuration-management
7+
tools (e.g., Ansible, Chef, Puppet, cfengine) that integrates cleanly
8+
with the Debian packaging system: you can apply configuration by
9+
installing a configuration package, and remove it cleanly by
10+
uninstalling it. config-package-dev uses `dpkg-divert` to inform the
11+
packaging system that it is changing files owned by another package,
12+
which means that your changes remain applied even when the original
13+
package is upgraded.
14+
15+
Configuration packages are particularly useful for sites using Debian or
16+
Ubuntu (or another dpkg-based distribution) and are already running
17+
their own interrnal apt repository. You can provide site defaults and
18+
configuration through your existing package-update processes, and make
19+
sure systems are up-to-date in both software and configuration by
20+
checking what versions of packages they have installed.
21+
(config-package-dev is not intended for use by packages in Debian
22+
itself.)
23+
24+
config-package-dev is a project of [MIT SIPB](https://sipb.mit.edu/),
25+
and was originally developed for the
26+
[Debathena](https://debathena.mit.edu) project to provide functionality
27+
to access MIT computing services (e.g., Kerberos and AFS configuration)
28+
on privately owned machines.
29+
30+
To get started, install `config-package-dev` from your package manager;
31+
we support the versions in the Debian and Ubuntu archives. Take a look
32+
at the [examples](examples/debhelper), or check out the full
33+
documentation at
34+
[https://debathena.mit.edu/config-package-dev](https://debathena.mit.edu/config-package-dev).
35+
If you're using config-package-dev, please also join the
36+
[config-package-dev@mit.edu mailing
37+
list](https://mailman.mit.edu/mailman/listinfo/config-package-dev).
38+
39+
config-package-dev itself is [licensed under the
40+
GPLv2+](debian/copyright), but the code it
41+
adds to configuration packages is [released under the MIT
42+
license](https://github.com/sipb/config-package-dev/commit/8d36c7611f0b3f3a16447b613d0e2a6ad0b1059f#diff-e93fa5c394e60f185a53f9ff00b68eb2)
43+
and automatically includes the MIT license in the added code.
44+
45+
Feel free to report bugs or submit patches either on GitHub or [on the Debian
46+
bug tracker](https://bugs.debian.org/src:config-package-dev).
47+
48+
[![Build Status](https://travis-ci.org/sipb/config-package-dev.svg?branch=master)](https://travis-ci.org/sipb/config-package-dev)

0 commit comments

Comments
 (0)