Add README

1 files changed, 28 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..1f717e0
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+This is a collection of scripts that I'm using to ease the pain of
+developing on the X.Org platform. Some cornerstone capabilities:
+
+- Geared towards Ubuntu, since that's what I use
+- Makefile to simply full build updates (pulling a lot of repositories and
+  building / autoconf'ing)
+- Scripts to keep your entire custom X.Org in a prefix inside your home
+  directory
+- Normal distribution startup will use distribution X.Org
+- Helper scripts are available to start custom-X.Org desktop sessions (you
+  should install 85rescue-library-path)
+- Supports programming on one machine, and actually running X on a different
+  machine (though in my setup, all machines are fairly similar in terms of
+  software that runs on them)
+- Best used with ccache & distcc (Hint: You may want to install your
+  distribution's packages and start distccd as a service)
+
+This is not intended to be a released software package, since a lot of
+things are *really* specific to my style of working, and to the fact that I'm
+mostly hacking on Radeon 3D. However, I put it available for everybody so that
+you may take your pick and put together whatever scripts will help your
+particular problem.
+
+Note: Kudos go to many other scripts that I've stolen from (particularly the
+git_xorg.sh, and probably others about which I've forgotten since then),
+and you are explicitly encouraged to steal from my scripts. Consider
+anything without an explicit statement saying otherwise to be in the public
+domain.