aboutsummaryrefslogtreecommitdiffstats
path: root/dists/gentoo/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'dists/gentoo/readme.txt')
-rw-r--r--dists/gentoo/readme.txt36
1 files changed, 36 insertions, 0 deletions
diff --git a/dists/gentoo/readme.txt b/dists/gentoo/readme.txt
new file mode 100644
index 00000000..cf6dfcc1
--- /dev/null
+++ b/dists/gentoo/readme.txt
@@ -0,0 +1,36 @@
+---------------------------------------
+1. Introduction
+---------------------------------------
+This directory contains two ebuilds for UltraStar Deluxe
+- ultrastardx-9999.ebuild: a live ebuild using SVN sources
+- ultrastardx-1.1_alpha.ebuild: a snapshot ebuild that might be appended to the official portage someday (Note: at the moment there is no source snapshot for USDX so this will not work)
+
+---------------------------------------
+2. Create a portage overlay
+---------------------------------------
+If you want to try one of the ebuilds (at the moment only use the live ebuild) you must have a portage overlay.
+In case you do not have one or do not know what it is, see
+ http://gentoo-wiki.com/HOWTO_Create_an_Updated_Ebuild
+
+Normally this can be achieved (as root) with:
+ mkdir -p /usr/local/portage && echo 'PORTDIR_OVERLAY="/usr/local/portage"' >> /etc/make.conf
+
+---------------------------------------
+3. Add the USDX ebuild to your overlay
+---------------------------------------
+First create the directory structure (as root):
+ mkdir -p /usr/local/portage/games-arcade/ultrastardx
+
+Now copy the (live) ebuild to the new directory:
+ cp ultrastardx-9999.ebuild /usr/local/portage/games-arcade/ultrastardx
+
+Go to the overlay directory:
+ cd /usr/local/portage/games-arcade/ultrastardx
+
+Create a manifest:
+ ebuild ultrastardx-9999.ebuild manifest
+
+And you are done!
+
+Now you can emerge USDX with:
+ emerge ultrastardx -av