From b39fd80d8c92bc1891c371ed8aa4314920aec144 Mon Sep 17 00:00:00 2001 From: Josh Holtrop Date: Sun, 7 Jul 2019 21:29:30 -0400 Subject: [PATCH] user guide: add ./configure && make Appendix section --- doc/user_guide.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/doc/user_guide.md b/doc/user_guide.md index b2738b2..290d4f8 100644 --- a/doc/user_guide.md +++ b/doc/user_guide.md @@ -1104,6 +1104,42 @@ build do end ``` +##> ./configure && make + +You can make your Rscons-based project more familiar to users of +autoconf-generated projects by creating a `configure` script and a `Makefile` +for the user. +Such users may be used to executing: + +``` +./configure +make +``` + +to build a project. +To do this, create a `configure` script with contents similar to the following: + +``` +#!/bin/sh +exec "$(dirname "$0")"/rscons "$@" +``` + +and make it executable with `chmod +x configure`. + +If you want your users to be able to build/clean a project with `make` but +still make use of Rscons under the hood, you can create a `Makefile` with +contents something like this: + +``` +.PHONY: all +all: + ./rscons build + +.PHONY: clean +clean: + ./rscons clean +``` + ##> YARD API Documentation See [here](../yard/index.html) for Rscons YARD API Documentation.