README

   1 DragonFly Ports, a.k.a. "DPorts"
   2 ================================
   3
   4 DragonFly Ports is a derivative of FreeBSD's Ports Collection.  It serves
   5 the same purpose for DragonFly as the Ports Collection does for FreeBSD,
   6 which is to provide instructions on how to build software on DragonFly BSD.
   7 The products of DPorts are executable software which are manipulated by
   8 Baptiste Daroussin's pkg(8) binary package manager.
   9
  10 Building a DPort from source is not generally encouraged.  It is suggested
  11 to use the official pre-built binaries instead.  However, in the case the
  12 binaries have a undesirable option selection or a bug that is fixed in the
  13 sources, then building the DPort from source is the only option.  Of
  14 course, it is possible to build all desired DPorts from source.
  15
  16 This repository is actually generated.  Starting with the Ports Collection
  17 as a basis, DragonFly-specific patches and/or files are applied as
  18 necessary to create a modified port that builds on DragonFly.  If the
  19 FreeBSD port is updated in a way that either causes the patches to no
  20 longer apply, or just outright fails to build on DragonFly, the update will
  21 not be carried forward.  The last working DPort will remain in place until
  22 a manual fix is provided that allows the FreeBSD update to work on
  23 DragonFly as well.
  24
  25 Poudriere, from ports-mgmt/poudriere-devel, is used to confirm good builds.
  26 If a build is successful, a hook will update the patches
  27 repository to indicate a good build, and then another script will generate
  28 the DPort, place it here, and commit the change.  Theoretically, every
  29 single DPort should build on DragonFly.  In practice, ports may build only
  30 on the dev branch of DragonFly, so the older the release is, the more
  31 DPorts that won't build (only the two 2 releases are checked).  Usually
  32 less than 10 failures occur on "master".
  33
  34 Please report generic issues (those that affect FreeBSD and DragonFly) at:
  35 https://bugs.freebsd.org/bugzilla/
  36
  37 Please report DragonFly-specific issues here:
  38 https://github.com/DragonFlyBSD/DPorts/issues/
  39
  40 If you are confident in a DragonFly-specific fix, please initiate a Github
  41 Pull Request here:
  42 https://github.com/DragonFlyBSD/DeltaPorts
  43
  44 Note that since DPorts is generated, Github Pull Requests against DPorts
  45 can not be accepted.  Only the DeltaPorts overlay or the FreeBSD ports
  46 base can be modified.
  47
  48 This project was conceived and implemented by John Marino.