README.md

   1 # Ravenports
   2 Universal package builder system
   3
   4 ## Objective
   5
   6 To develop the next generation software collection builder and packager
   7 that is also truly cross-platform.  Think FreeBSD ports with several new
   8 cutting edge features and enhancements, but with equal support to Linux,
   9 Solaris(like), MacOS, and all BSD platforms.
  10
  11 It is not a reinvention of pkgsrc.  The approach is new and not based
  12 on make.
  13
  14 ## Ravenports Triad
  15
  16 There are three main components of Ravenports.
  17
  18   1. **Source ports:**
  19 This component, known as "ravensource" is not seen or utilized by
  20 regular users.  It resembles
  21 the ports tree seen in FreeBSD and pkgsrc, but only at the individual
  22 port directory level.  It is not arranged in categories.  The contents
  23 of each port directory is used to generate a port buildsheet.
  24
  25   2. **Conspiracy:**
  26 The conspiracy repository contains all the buildsheets, separated into
  27 256 bucket directories.  These single files are the complete recipe for
  28 building the software for which they were created.  These buildsheets
  29 are not meant to be viewed directly, as their information can be queried
  30 by the ravenadm tool.  The conspiracy buildsheets are "compiled" from
  31 ravensource and getting the latest ports is accomplished by updating the
  32 repository.  This README is contained within the Conspiracy repository.
  33
  34   3. **Raven administration tool:**
  35 The administration tool for Ravenports is "ravenadm".  It can query the
  36 ports for many types of information like a database.  It can build
  37 packages in parallel (think synth interface).  It controls the build
  38 environment such that it is the same across users, even if those
  39 users are on different operating systems.  Raven also plays a part
  40 in the development of ports and features inbuilt lint, sanity checks
  41 and compile checks.  If somebody develops a buildsheet that passes
  42 all checks and builds, it likely can be incorporated in the source
  43 tree as submitted, especially if the submission process includes
  44 automated testing on all supported platforms.
  45
  46 ## Make has really been eliminated?
  47
  48 Actually, not really.  Make is pretty good at the actual building of the
  49 port.  A significant chunk of FreeBSD's build logic will be retained
  50 (although improved upon).  Raven will generate a makefile dynamically
  51 depending on options and variants requested for the purpose of
  52 building and packaging the software.  The logic will be straight-forward
  53 without recursion or shell forking.  Keeping this logic at
  54 ${RAVENBASE}/share/mk will ensure adaptability.
  55
  56 The options handling and other complex logic that affect package
  57 dependencies will be done by the ravenadm internally.  This will
  58 enable speedups by magnitudes as compared to other ports systems.
  59
  60 ## Official Website
  61
  62 Please visit
  63 [http://www.ravenports.com](http://www.ravenports.com)
  64 for additional and current information.
  65
  66 ## License
  67
  68 The contents of this repository are available under the
  69 conditions defined by the Internet Systems Consortium (ISC) license:
  70
  71 ---
  72
  73 ```
  74 Copyright (c) 2017-2018, The Ravenports Project.
  75
  76 Permission to use, copy, modify, and/or distribute this software for any
  77 purpose with or without fee is hereby granted, provided that the above
  78 copyright notice and this permission notice appear in all copies.
  79
  80 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  81 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  82 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  83 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  84 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  85 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  86 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  87 ```