Add basic CONTRIBUTING file

[android-x86/external-libdrm.git] / README

diff --git a/README b/README
index 603a1c1..f3df9ac 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 libdrm - userspace library for drm
 
 This  is libdrm,  a userspace  library for  accessing the  DRM, direct
-rendering  manager, on  Linux,  BSD and  other  operating systes  that
+rendering  manager, on  Linux,  BSD and  other  operating systems that
 support the  ioctl interface.  The library  provides wrapper functions
 for the  ioctls to avoid  exposing the kernel interface  directly, and
 for chipsets with drm memory manager, support for tracking relocations
@@ -15,9 +15,27 @@ with an older kernel.
 Compiling
 ---------
 
-libdrm  is  a  standard  autotools  packages and  follows  the  normal
-configure, build  and install steps.   The first step is  to configure
-the package, which is done by running the configure shell script:
+libdrm has two build systems, a legacy autotools build system, and a newer
+meson build system. The meson build system is much faster, and offers a
+slightly different interface, but otherwise provides an equivalent feature set.
+
+To use it:
+
+    meson builddir/
+
+By default this will install into /usr/local, you can change your prefix
+with --prefix=/usr (or `meson configure builddir/ -Dprefix=/usr` after 
+the initial meson setup).
+
+Then use ninja to build and install:
+
+    ninja -C builddir/ install
+
+If you are installing into a system location you will need to run install
+separately, and as root.
+
+
+Alternatively you can invoke autotools configure:
 
        ./configure
 
@@ -37,5 +55,5 @@ and once make finishes successfully, install the package using
 
        make install
 
-If you are install into a system location, you will need to be root to
-perform the install step.
+If you are installing into a system location, you will need to be root
+to perform the install step.