diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..5fc491fb --- /dev/null +++ b/docs/index.html @@ -0,0 +1,76 @@ + + +debian-cd + +debian-cd +

An attempt at documentation!

+ +

debian-cd is a small but quite complex package. On the surface, its +job is simple - make CD images from a Debian archive. The details are +rather more involved...

+ +

Overview - what goes on a CD?

+ +

There are several important items that make up a Debian +CD. Depending on the type of CD, not all of them are needed.

+ + + +

The only things that must be on a Debian CD for it +to recognised as such are the volume info, the files that give some +information about the CD itself. Everything else is strictly optional, +but without anything else on the CD it won't be very useful!

+ +

A normal installation CD will contain all five of the above +sections, but other combinations can be useful too. A bootable +business card CD will contain volume info, d-i and bootable files, but +no actual packages or sources - the installer will download the bits +it needs. An update CD will contain volume info, packages and package +metadata - it's expected to be used just as a source of new packages +for an existing system.

+ +

For more information on the layout of the CD, see CD contents.

+ +

Overview (again) - how does debian-cd work?

+ +

debian-cd is made up of a large central Makefile and lots of +small(ish) helper scripts written in sh and perl. It depends on +various other packages to do lots of the hard work, for example apt to +calculate t package dependencies and debootstrap to provide the list +of packages needed for a base installation.

+ +

A typical debian-cd run will involve:

+ + + +

This is a rough guide only - see later for more +details on each of the steps!

+ + + \ No newline at end of file