summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..6b4c2821d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Pale Moon web browser
+
+This is the source code for the Pale Moon web browser, an independent browser derived from Firefox/Mozilla community code. The source tree is
+laid out in a "comm-central" style configuration where only the code specific to Pale Moon is kept in this repository.
+
+The shared Unified XUL Platform source code is referenced here as a git submodule contained in the `platform/` directory and is required to build the application.
+
+## Getting the platform sub-module
+`git submodule init && git submodule update`
+
+## Resources
+
+ * [Build Pale Moon for Windows](https://developer.palemoon.org/build/windows/)
+ * [Build Pale Moon for Linux](https://developer.palemoon.org/build/linux/)
+ * [Pale Moon home page](http://www.palemoon.org/)
+ * [Code of Conduct, Contributing, and UXP Coding style](https://repo.palemoon.org/MoonchildProductions/UXP/src/branch/master/docs)