Add Gentoo build instructions.

1 files changed, 67 insertions, 0 deletions

diff --git a/GENTOO-README.md b/GENTOO-README.md
new file mode 100644
index 0000000..bbd9d74
--- /dev/null
+++ b/GENTOO-README.md
@@ -0,0 +1,67 @@
+Gentoo Build Instructions
+=========================
+
+This repository adds support for Gentoo Systems, but will not work if you simply
+run `make` and do nothing else.
+
+This has been tested only on my system so far. It compiles everything, and gets
+to the point where `make run` will indeed bring up a Sugar session, but I can't
+guarantee that I didn't forget a step or typo a dependency or something else
+that would make the build fail on systems other than my own.
+
+Patches are welcome to smooth out this process.
+
+USE Flags
+---------
+
+A couple packages require USE flags that aren't set by default in order to
+include the proper modules and such.
+
+Here's the relevant part of my `/etc/portage/package.use`. Again, chances are
+something else is missing.
+
+```
+x11-libs/vte python
+x11-libs/hippo-canvas python
+```
+
+Package Keywords
+----------------
+
+Here are some relevant entries in my
+`/etc/portage/package.accept_keywords`. Once again, probably missing something.
+
+```
+=net-voip/telepathy-salut-0.3.10 ~amd64
+# required by x11-libs/vte-0.28.2-r204
+=dev-libs/glib-2.34.3 ~amd64
+# required by dev-libs/gobject-introspection-1.34.2-r1
+=dev-libs/gobject-introspection-common-1.34.2 ~amd64
+# required by dev-libs/libgee-0.8.4[introspection]
+=dev-libs/gobject-introspection-1.34.2-r1 ~amd64
+# required by app-accessibility/at-spi2-atk (argument)
+=app-accessibility/at-spi2-atk-2.6.2 ~amd64
+
+```
+
+If `make build` fails with a mask warning, manually unmask the package, and let
+me know so I can add it to the README.
+
+It didn't work!
+---------------
+
+If you run `make build` twice and still see it trying to pull in dependencies,
+that means that one of the things that is being pulled in is not satisfying the
+dependency that it is claiming to. Let me know about this, or try to debug it
+yourself by looking through `config/packages/deps.json` and grepping for what's
+being pulled in for gentoo versus what's being used for Debian/Ubuntu/Fedora.
+
+
+Disclaimer
+----------
+
+This is an unofficial addition to sugar-build. I cannot guarantee that it will
+work out of the box for anyone's set up excluding my own.
+
+I would like to make this as seamless as possible, so please report any bugs you
+find.