summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMoonchild <moonchild@palemoon.org>2022-02-12 17:47:03 +0000
committerMatt A. Tobin <email@mattatobin.com>2022-02-12 14:23:18 -0600
commitf66babd8b8368ada3e5aa29cdef1c77291ee4ddd (patch)
treee3842e2a6bf19090185f9c475b3846e1bb79ac97 /README.md
downloadGRE-f66babd8b8368ada3e5aa29cdef1c77291ee4ddd.tar.gz
Create the Goanna Runtime Environment
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..1f412d9c1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Goanna Run-time Environment (GRE)
+
+This repository holds the code for [Goanna](http://www.moonchildproductions.info/goanna.shtml)-based platform code for XUL-based
+applications. It is a hard fork from the Mozilla code repository (mozilla-central).
+
+In addition to further development based on the Mozilla sourced code, and
+selective cherry-picking of directly-applicable patches, this repository has its
+own development and holds the base for a maintained platform to be used by XUL
+applications.
+
+For a list of active projects making use of the Unified XUL Platform, check out
+http://thereisonlyxul.org/.
+
+## Additional documentation
+
+Additional documentation relevant to this source code can be found in the `/docs`
+directory. This will contain relevant documentation regarding contributing,
+using and distributing this code and its binaries.
+
+If you are interested in the development and building side of things, some
+information will be available on the [Pale Moon developer site](http://developer.palemoon.org).
+You are also always welcome to get in touch with our community on the [Pale Moon forum](https://forum.palemoon.org/).
+
+### A note about trademarks and branding
+
+Although this repository is licensed under Mozilla Public License v2.0, the
+trademarks and brands contained herein remain the property of their respective
+owners. For more details, please see the notifications in the respective directories.
+
+### Foundation and maintainership
+
+This repository has been founded by Moonchild (M.C. Straver) and is maintained by him
+and other community members.
+If you fork this repository to perform your own work on it, please consider offering
+improvement patches upstream to its origin to mutually improve the platform and build
+a future for XUL.