summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2019-10-13 05:29:54 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2019-10-13 05:29:54 -0500
commit56bf0e8d486828584596c6c28274b5d7608b6456 (patch)
treee61cc569247ffa24233ab28d85bd61b580dda75e /README.rst
parent536da1a3b146037c0f34fb7a767020538bdcc44d (diff)
downloadhorizon-56bf0e8d486828584596c6c28274b5d7608b6456.tar.gz
horizon-56bf0e8d486828584596c6c28274b5d7608b6456.tar.bz2
horizon-56bf0e8d486828584596c6c28274b5d7608b6456.tar.xz
horizon-56bf0e8d486828584596c6c28274b5d7608b6456.zip
docs: Fix up nicely
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst120
1 files changed, 117 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 574c895..53db374 100644
--- a/README.rst
+++ b/README.rst
@@ -9,14 +9,26 @@
* **Zach van Rijn**, design and requirements
* **Alyx Wolcott**, analyst assistant
:Status:
- Requirements Phase
+ Development
:Copyright:
© 2015-2019 Adélie Linux.
- Code: NCSA license.
+ Code: AGPL-3.0 license.
Documentation: CC BY-NC-SA open source license.
+Project Horizon is the next-generation installation system for Adélie Linux.
+It provides everyone with tools that make installation easy, inspectable,
+auditable, secure, and fast.
+
+.. image:: https://img.shields.io/badge/chat-on%20IRC-blue.svg
+ :target: ircs://irc.interlinked.me:6697/#Adelie-Support
+
+.. image:: https://img.shields.io/badge/license-AGPL3-lightgrey.svg
+ :target: LICENSE-code
+
+
+
Introduction
============
@@ -32,10 +44,112 @@ Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
You should have received a copy of the license along with this
work. If not, see <http://creativecommons.org/licenses/by-nc-sa/4.0/>.
-Code is licensed under the Adélie-standard NCSA license.
+Code is licensed under the Affero GPL (AGPL) 3 license.
Changes
```````
Any changes to this repository must be reviewed before being pushed to the
master branch.
+
+
+
+If You Need Help
+================
+
+This repository is primarily for system developers. If you're looking for
+help using or installing Adélie Linux, see `our Help Centre on the Web`_.
+
+.. _`our Help Centre on the Web`: https://help.adelielinux.org/
+
+
+
+Repository Layout
+=================
+
+Project Horizon is laid out into multiple directories for ease of maintenance.
+
+``build``: Build system artefacts
+`````````````````````````````````
+The ``build`` directory contains build output, including binaries and shared
+libraries.
+
+
+``devel``: Development information
+``````````````````````````````````
+The ``devel`` directory contains the Vision document, the Functional Software
+Requirements Specification for Project Horizon, and the official HorizonScript
+Specification. The documents are written in DocBook XML; the HTML and PDF
+versions are not stored in this repository.
+
+
+``hscript``: HorizonScript library
+``````````````````````````````````
+The ``hscript`` directory includes the source code for the HorizonScript
+library. This is the primary library for parsing, validating, and executing
+HorizonScript files, and contains the principal code for Project Horizon.
+
+
+``tools``: Tooling and accessories
+``````````````````````````````````
+The ``tools`` directory includes the source code for tools related to Project
+Horizon, including:
+
+* The Validation Utility, which allows you to validate manually written
+ installfiles.
+
+* The Simulator, which allows you to view how the Horizon Runner would
+ interpret your installfile. The Simulator additionally allows you to
+ output the interpretation of your installfile to a shell script.
+
+
+``util``: Shared utility code
+`````````````````````````````
+The ``util`` directory includes source code that is common between libraries
+and tools.
+
+
+``tests``: Test infrastructure
+``````````````````````````````
+The ``tests`` directory includes the ``fixtures`` directory, which is a
+collection of dozens of example installfiles that exercise the parsing
+and validation code of libhscript. Some of these installfiles are
+purposefully invalid, and others contain edge cases to ensure that the
+library is written and implemented correctly.
+
+It also contains the ``spec`` directory, which is a series of RSpec tests
+designed to use the fixtures and ensure the correct output is given.
+
+
+``3rdparty``: External code
+```````````````````````````
+The ``3rdparty`` directory contains vendored code. Currently, this is only
+the clipp_ project, used by the ``tools`` for argument parsing.
+
+.. _clipp: https://github.com/muellan/clipp
+
+
+
+Contributing
+============
+
+See the CONTIRIBUTING.rst_ file in the same directory as this README for
+more details on how to contribute to Project Horizon.
+
+.. _CONTRIBUTING.rst: CONTRIBUTING.rst
+
+
+
+Reporting Issues
+================
+
+If you have an issue using Project Horizon, you may view our BTS_. You may
+also `submit an issue`_ directly.
+
+For general discussion, questions, or to submit a patch, please use the
+`Horizon mailing list`_.
+
+.. _BTS: https://bts.adelielinux.org/buglist.cgi?product=Horizon&resolution=---
+.. _`submit an issue`: https://bts.adelielinux.org/enter_bug.cgi?product=Horizon
+.. _`Horizon mailing list`: https://lists.adelielinux.org/postorius/lists/horizon.lists.adelielinux.org/
+