The New Plan

ebuild branch has old ebuilds.  profiles dir still has CFLAGS.

Everything else is removed or modified for changing of upstream to
Alpine.

1 files changed, 51 insertions, 30 deletions

diff --git a/README.rst b/README.rst
index ff96929ad..fa4bf59be 100644
--- a/README.rst
+++ b/README.rst
@@ -3,12 +3,11 @@
 =====================================
 :Authors:
   * **A. Wilcox**, primary maintainer
-  * **Elizabeth Myers**, maintainer
   * **Adélie Linux Developers and Users**, contributions
 :Status:
   Production
 :Copyright:
-  © 2016 Adélie Linux Team.  NCSA open source licence.
+  © 2017 Adélie Linux Team.  NCSA open source licence.
 
 
 
@@ -16,9 +15,9 @@
 Introduction
 ============
 
-This repository contains the Adélie Linux package set.  It is used as an
-overlay in the Portage system for package building to create the repository
-used by Adélie's APK package manager.
+This repository contains the Adélie Linux package set.  It is used by the
+Adélie Linux build system for package building to create the repository used
+by Adélie's APK package manager.
 
 
 Licenses
@@ -49,16 +48,30 @@ It does not list every package available; it is merely a guide to help you
 find what you need.
 
 
-``profiles``: Configuration
-```````````````````````````
-The ``profiles`` directory contains special instructions to the Portage++
-system to ensure proper build and runtime configuration for packages.
+``system``: System-level packages
+`````````````````````````````````
+The ``system`` directory contains special packages used by Adélie for core
+system functionality.  This directory is kept separate from ``user`` to
+facilitate sharing of user packages with other APK-based distributions.
 
 
-``sys-apps``: System Applications
-`````````````````````````````````
-Packages in the ``sys-apps`` category provide core system functionality, such
-as ``apk-tools`` or ``portage++``.
+``user``: User packages
+```````````````````````
+The ``user`` directory contains packages that a user would typically be
+interested in installing.  Desktop applications, server software (also known as
+*daemons*), and other useful packages can be found here.
+
+
+``nonfree``: Bad packages
+`````````````````````````
+The ``nonfree`` directory contains packages that are under a restrictive or
+commercial license.  You need to read the license agreements to these packages
+before installing them.  Binary drivers for devices like high-end graphics
+devices and wireless network controllers can be found here, as well as some
+limited commercial software where it is legal for us to provide them.
+
+Where it is not legal for us to redistribute a non-free package, you will need
+to build it yourself and install it on your system manually.
 
 
 
@@ -72,31 +85,39 @@ This section contains usage information for this repository.
 As an overlay
 `````````````
 
-This repository can be added as an overlay to any system running Portage or
-Portage++.  However, please do not add it to a Gentoo computer unless you
-intend to use it for developing Adélie.  None of the packages here are useful
-for a Gentoo computer, and some packages (such as ``baselayout``) may in fact
-damage your Gentoo installation if installed from this repository.  Please be
-careful.
+This repository can be added as an overlay to any system running APK, which
+at the time of this writing includes Alpine Linux, postmarketOS, and a few
+others.  However, please do not add ``system`` or ``nonfree`` to a computer
+running a different distribution unless you are fully aware of the concerns
+surrounding mixing packages in such a manner.  None of the packages in the
+``system`` repository are useful for an Alpine computer, and some packages
+(such as ``baselayout`` or ``adelie-base``) may in fact damage your Alpine
+installation if installed.  Please be careful.
 
-Create a file named ``adelie.conf`` to ``/etc/portage/repos.conf``, and enter
-the following text:
+The domain ``distfiles.adelielinux.org`` is a round-robin for all available
+Adélie mirrors.  You may add a repository named above to
+``/etc/apk/repositories``:
 
 ::
 
-  [adelie]
-  location = /usr/local/portage-adelie
-  sync-type = git
-  sync-uri = https://code.foxkit.us/adelie/packages.git
-  auto-sync = yes
+  https://distfiles.adelielinux.org/adelie/$version/$repo
+
+Where ``$version`` is the version of Adélie Linux you are running, or
+``current`` for automatic upgrades, or ``dev`` for a rolling-release
+style distribution (which may be unstable - you have been warned!).
+
+``$repo`` should be replaced with the name of the repository you are wanting
+to use, such as ``user``.
 
-Run ``emerge --sync`` or ``eix-sync`` to update the package index on your
-local system.  The packages will then be available to you.
+Run ``apk update`` to update the package index on your local system.  The
+packages will then be available to you.
 
 
 As a repository
 ```````````````
 
-The Adélie Linux system is preconfigured to use packages in this repository
-for APK.  No configuration is required.
+The Adélie Linux system is preconfigured to use packages in ``system`` and
+``user`` for APK.  No configuration is required.  If you wish to add
+``nonfree``, see the instructions above, noting that ``$repo`` should be
+``nonfree`` in this case.