summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst31
1 files changed, 17 insertions, 14 deletions
diff --git a/README.rst b/README.rst
index ad7db9cd5..6646f9865 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,10 @@
README for Adélie Linux Package Set
=====================================
:Authors:
- * **A. Wilcox**, primary maintainer
+ * **A. Wilcox**, Distro Lead
+ * **Elizabeth Myers**, Platform Group
+ * **Horst Burkhardt**, Platform Group
+ * **William Pitcock**, Platform Group
* **Adélie Linux Developers and Users**, contributions
:Status:
Production
@@ -24,8 +27,7 @@ Licenses
`````````
As the Adélie Linux project is an open-source Linux distribution, packages
contained in this repository must also be provided under a license recognised
-by the OSI_. A separate repository may be provided in the future for certain
-non-free components, such as device driver firmware.
+by the OSI_. No exceptions will be made.
.. _OSI: http://opensource.org/licenses/category
@@ -50,9 +52,8 @@ find what you need.
``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.
+The ``system`` directory contains packages used by Adélie for core system
+functionality. Special care should be taken before bumping these packages.
``user``: User packages
@@ -75,12 +76,10 @@ As an overlay
The ``user`` 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`` 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.
+few others. However, please ensure you are fully aware of the concerns
+surrounding mixing packages in such a manner. There may be different ABIs or
+library versions between each distribution, and packages may crash, experience
+instability, or fail to launch at all. Please be careful.
The domain ``distfiles.adelielinux.org`` is a round-robin for all available
Adélie mirrors. You may add a repository named above to
@@ -91,7 +90,7 @@ Adélie mirrors. You may add a repository named above to
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
+``current`` for automatic stable 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
@@ -100,10 +99,14 @@ to use, such as ``user``.
Run ``apk update`` to update the package index on your local system. The
packages will then be available to you.
+If you are using the repository on a non-Adélie system, you should use
+repository pinning for the Adélie repositories you add. Please consult the
+APK manual for more information about repository pinning.
+
As a repository
```````````````
The Adélie Linux system is preconfigured to use packages in ``system`` and
-``user`` for APK. No further configuration is required.
+``user`` for APK. No further configuration should be required.