Changeset 1001


Ignore:
Timestamp:
Feb 28, 2008, 8:53:20 PM (10 years ago)
Author:
dkg
Message:

debirf: clean up README: move it to new subcommand syntax, make the examples more concrete.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/debirf/docs/README

    r909 r1001  
    33in a fully functional Debian system.
    44
    5 debirf has a module architecture that allows users to easily customize
    6 the images that they build, using simple shell scripts, to do
    7 basically anything that Debian can do.  Some included example
     5debirf has a modular architecture that allows users to easily
     6customize the images that they build, using simple shell scripts, to
     7do basically anything that Debian can do.  Some included example
    88"profiles" are:
    99
    1010minimal:
    1111  very minimal system with no extras, including no man pages or udev.
    12   - requires ~230M for buildd, and produces a 47M initramfs.
     12  - requires ~230M of disk space to build, and produces a ~47M initramfs.
    1313
    1414rescue:
    1515  includes a full complement of system repair utilities,including
    1616  mdadm, lvm2, testdisk, foremost, etc.
    17   - requires ~250M for buildd, and produces a 51M initramfs.
     17  - requires ~250M of disk space to build, and produces a ~51M initramfs.
    1818
    1919xkiosk:
     
    2121  you can pass it the "browse=URL" boot parameter to specify a startup
    2222  URL.
    23   - requires ~600M for buildd, and produces a 127M initramfs.
     23  - requires ~600M of disk space to build, and produces a ~127M initramfs.
    2424
    2525gzipped archives of these profiles are included with debirf in
     
    2727includes a debirf.conf, and a modules directory that includes links to
    2828the various modules that the profile uses.  Start by unpacking one of
    29 the example profiles, e.g.:
     29the example profiles.  For example, to start working with the minimal
     30profile in a debirf subdirectory of your homedir:
    3031
    31 $ cd /path/to
    32 $ tar xzf /usr/share/doc/debirf/example-profiles/<profile>.tgz
     32$ mkdir ~/debirf
     33$ cd ~/debirf
     34$ tar xzf /usr/share/doc/debirf/example-profiles/minimal.tgz
    3335
    3436Before building, you can modify the debirf.conf as desired to specify
     
    3638buildd), and which Debian mirror and distro to use (ala. debootstrap).
    3739Once you have your profile ready, build it with the debirf build
    38 script:
     40script.  Following the example above:
    3941
    40 $ debirf /path/to/<profile>
     42$ cd ~/debirf
     43$ debirf make minimal
    4144
    4245The debirf script creates the root filesystem for the new image using
     
    4851burnt to read-only media, or supplied by a netboot server.
    4952
     53If you want to burn the debirf profile to a CD, you might want to make
     54a CD image first.  Following the above example:
     55
     56$ cd ~/debirf
     57$ debirf makeiso minimal
     58
     59There should now be a bootable ISO image stored at:
     60~/debirf/minimal/debirf-minimal.iso, which you can burn using a tool
     61like wodim.
     62
    5063Have fun!  Create new modules and profiles for your specific needs.
    5164If you think your module or profile would be generally useful, please
     
    5669
    5770http://cmrg.fifthhorseman.net/wiki/debirf
    58 debirf@cmrg.fifthhorseman.net
     71debirf@fifthhorseman.net
Note: See TracChangeset for help on using the changeset viewer.