summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorCarsten Haitzler (Rasterman) <raster@rasterman.com>2017-12-17 09:53:54 +0900
committerCarsten Haitzler (Rasterman) <raster@rasterman.com>2017-12-17 09:53:54 +0900
commit4d9a02a3be9410f517bd56af16162ca8394ccc72 (patch)
tree25195e25b20c202fad6f6da335bad31f20cdec84 /INSTALL
parent07fee654d2db3ff00c51aaf57954cc67b66c88cd (diff)
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.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL59
1 files changed, 59 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 000000000..2eac4a6af
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,59 @@
1** COMPILING and INSTALLING **
2------------------------------
3
4Meson is the build system used for this project. For more information please
5see:
6
7 http://mesonbuild.com
8
9----
10
11Normal compilation in /usr/local:
12
13 meson . build
14 ninja -C build
15 sudo ninja -C build install
16
17For meson build generic options:
18
19 meson --help
20
21For a list of project specific options supported:
22
23 cat meson_options.txt
24
25To set 1 or more project specific options:
26
27 meson --prefix=/path/to -Doption=value [-Dother=value2] [...] . build
28
29To display current configuration:
30
31 meson configure build
32
33The above will only work after at least the following is done:
34
35 meson . build
36
37** QUICK AND DIRTY HELP **
38--------------------------
39
40How clean out the build and config and start fresh:
41
42 rm -rf build
43
44How to make a dist tarball and check its build:
45(must do it from git tree clone and commit all changes to git first)
46
47 ninja -C build dist
48
49How to change prefix:
50
51 meson --prefix=/path/to/prefix . build
52
53How to install in a specific destination directory for packaging:
54
55 DESTDIR=/path/to/destdir ninja -C build install
56
57How to build with verbose output (full commands run):
58
59 ninja -C build -v