summaryrefslogtreecommitdiffstats
path: root/elchos/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'elchos/README.md')
-rw-r--r--elchos/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/elchos/README.md b/elchos/README.md
new file mode 100644
index 00000000..4209db7c
--- /dev/null
+++ b/elchos/README.md
@@ -0,0 +1,23 @@
+# Elch
+This builds the elch sharing distribution.
+
+# Usage
+
+ # create a new iso
+ ./refresh
+ # creates:
+ # out/elchos.iso
+
+# Requirements
+Both development environment and Final Distro are based on a heavily remastered
+version of the Arch Linux Install Stick. On Arch you need archiso to build the
+distro.
+
+ pacman -Sy archiso
+
+# Configured URLs
+- elchstats.nsupdate.info -> the graphite stats receiver
+- elchirc.nsupdate.info -> the irc to be used
+ irc.freenode.net currently hardcoded
+ in root-image/krebs/etc/Reaktor/config.py
+- elchhub.nsupdate.info -> the dcpp hub to be used