From 4a53d311b5b612fcb9fe1f73c48c6c12cf7e085f Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sun, 12 Jun 2022 20:59:29 -0400 Subject: Rename INSTALL to INSTALL.md and add a link from README --- INSTALL | 66 ----------------------------------------------------------------- 1 file changed, 66 deletions(-) delete mode 100644 INSTALL (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 9b54f51e..00000000 --- a/INSTALL +++ /dev/null @@ -1,66 +0,0 @@ -Installation Instructions -========================= - -Basic Installation ------------------- - -Building this software requires only Python. To install with default options: - - ./waf configure - ./waf - ./waf install # or sudo ./waf install - -Configuration Options ---------------------- - -All supported options can be viewed using the command: - - ./waf --help - -Most options only need to be passed during the configure stage, for example: - - ./waf configure --prefix=/usr - ./waf - ./waf install - -Compiler Configuration ----------------------- - -Several standard environment variables can be used to control how compilers are -invoked: - - * CC: Path to C compiler - * CFLAGS: C compiler options - * CXX: Path to C++ compiler - * CXXFLAGS: C++ compiler options - * CPPFLAGS: C preprocessor options - * LINKFLAGS: Linker options - -Library Versioning ------------------- - -This library uses semantic versioning . - -Several major versions can be installed in parallel. The shared library name, -include directory, and pkg-config file are suffixed with the major version -number. For example, a library named "foo" at version 1.x.y might install: - - /usr/include/foo-1/foo/foo.h - /usr/lib/foo-1.so.1.x.y - /usr/lib/pkgconfig/foo-1.pc - -Dependencies can check for the package "foo-1" with pkg-config. - -Packaging ---------- - -Everything can be installed to a specific root directory by passing a --destdir -option to the install stage (or setting the DESTDIR environment variable), -which adds a prefix to all install paths. For example: - - ./waf configure --prefix=/usr - ./waf - ./waf install --destdir=/tmp/package - -Packages should allow parallel installation of several major versions. For -example, the above would be packaged as "foo-1". \ No newline at end of file -- cgit v1.2.1