Makefile.example

#!/usr/bin/env make
#
# XXX - Please remove these 3 XXX-ed comment lines - XXX
# XXX - Hint: Lines with XXX's in them should be removed once you read them and consider their suggestions - XXX
# XXX - Change "an example Makefile" in the line below to a suitable and short 1-line title for your submission - XXX
# prog - an example Makefile
#
# XXX - Please remove these 4 XXX-ed comment lines - XXX
# XXX - Please copy this file into your submission directory under the name: Makefile - XXX
# XXX - Modify the resulting Makefile as needed - especially lines with XXX's in them - XXX
# XXX - Please add a space after '=' in variables unless it's empty - XXX


#############################
# shell used by this Makefile
#############################
#
SHELL= bash

#######################
# common tool locations
#######################
#
CLANG= clang
GCC= gcc
RM= rm

# Common C compiler warnings to silence
#
# Example: CSILENCE= -Wno-some-thing -Wno-another-thing
#
# NOTE: If you add -Wno-stuff to CSILENCE, please update
#	CUNKNOWN in the next comment block.
#
# NOTE: Please don't add -Wno-unknown-warning-option to CSILENCE.
#
CSILENCE=

# Attempt to silence unknown warning option
#
# If you add -Wno-stuff to CSILENCE, then please change CUNKNOWN to read:
#
#	CUNKNOWN= -Wno-unknown-warning-option
#
CUNKNOWN=

# Common C compiler warning flags
#
CWARN= -Wall -Wextra -pedantic ${CSILENCE} ${CUNKNOWN}

# The standard to compile against
#
# Your IOCCC submission is free to require older C standards, or
# even not specify a C standard at all.  We suggest trying
# for -std=gnu17, but that is not a requirement and you won't
# be penalized if you name CSTD empty or use another
# well known and reasonably widely implemented C standard.
#
CSTD= -std=gnu17

# Compiler bit architecture
#
# Example for 32-bitness: ARCH= -m32
# Example for 64-bitness: ARCH= -m64
#
# NOTE: Normally one should not specify a specific architecture.
#
ARCH=

# Defines that are needed to compile
#
# Example: -Dfoo -Dbar=baz
#
CDEFINE=

# Include files that are needed to compile
#
# Example: CINCLUDE= -include stdio.h
#
CINCLUDE=

# Other flags to pass to the C compiler
#
# Example: COTHER= -fno-math-errno
#
COTHER=

# Optimization
#
OPT= -O3

# Default flags for ANSI C compilation
#
CFLAGS= ${CSTD} ${CWARN} ${ARCH} ${CDEFINE} ${CINCLUDE} ${COTHER} ${OPT}

# Libraries needed to build
#
LDFLAGS=

# C compiler to use
#
CC= cc

# Compiler add-ons or replacements for clang only
#
ifeq "$(findstring $(CLANG),${CC})" "$(CLANG)"
#
CSILENCE+=
#
CWARN+= -Weverything
#
endif

# Specific add-ons or replacements for gcc only
#
ifeq "$(findstring $(GCC),${CC})" "$(GCC)"
#
CSILENCE+=
#
CWARN+=
#
endif


###########################################
# Special Makefile variables for this entry
###########################################

# what to build
#
PROG= prog
OBJ= ${PROG}.o
TARGET= ${PROG}
#
# XXX - uncomment the below lines if you have alt targets - XXX
# XXX - make sure to add all alt objects and targets that - XXX
# XXX - you wish to have compiled by make alt             - XXX
#
#ALT_OBJ= ${PROG}.alt.o
#ALT_TARGET= ${PROG}.alt
#

# list any data files supplied with the submission
#
DATA=


#################
# build the entry
#################
#
all: data ${TARGET}
	@:

.PHONY: all data try clean clobber

# how to compile
#
${PROG}: ${PROG}.c
	${CC} ${CFLAGS} $< -o $@ ${LDFLAGS}

# alternative executable
#
alt: data ${ALT_TARGET}
	@${TRUE}

#
# XXX - if you have alt targets, add them here, like this - XXX
#
#${PROG}.alt: ${PROG}.alt.c
#	${CC} ${CFLAGS} $< -o $@ ${LDFLAGS}
#

# data files
#
data: ${DATA}
	@:

# one suggested way to run the program
#
try: ${PROG} ${DATA}
        # XXX - Please remove these 4 XXX-ed comment lines - XXX
        # XXX - Notice how we do not assume that . is a component in our PATH - XXX
        # XXX - If no args are necessary, you do not have to specify any - XXX
        # XXX - Change the next line as needed - XXX
        ./${PROG} some arguments


###############
# utility rules
###############
#
clean:
	${RM} -f ${OBJ} ${ALT_OBJ}

clobber: clean
	${RM} -f ${TARGET} ${ALT_TARGET}