readme/install - use standard INSTALL file like autofoo projects

also document the same way with sudo install. ninja bug should go away
and those rebuilding the same tree again and again can deal with
chowning back to themselves as most people needing these docs will be
those setting up build scripts that build just once.

1 files changed, 59 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000000..2eac4a6af4
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,59 @@
+** COMPILING and INSTALLING **
+------------------------------
+
+Meson is the build system used for this project. For more information please
+see:
+
+    http://mesonbuild.com
+
+----
+
+Normal compilation in /usr/local:
+
+    meson . build
+    ninja -C build
+    sudo ninja -C build install
+
+For meson build generic options:
+
+    meson --help
+
+For a list of project specific options supported:
+
+    cat meson_options.txt
+
+To set 1 or more project specific options:
+
+    meson --prefix=/path/to -Doption=value [-Dother=value2] [...] . build
+
+To display current configuration:
+
+    meson configure build
+
+The above will only work after at least the following is done:
+
+    meson . build
+
+** QUICK AND DIRTY HELP **
+--------------------------
+
+How clean out the build and config and start fresh:
+
+    rm -rf build
+
+How to make a dist tarball and check its build:
+(must do it from git tree clone and commit all changes to git first)
+
+    ninja -C build dist
+
+How to change prefix:
+
+    meson --prefix=/path/to/prefix . build
+
+How to install in a specific destination directory for packaging:
+
+    DESTDIR=/path/to/destdir ninja -C build install
+
+How to build with verbose output (full commands run):
+
+    ninja -C build -v