fix Makefile and README.md for 2011/zucke

2011/zucker/Makefile

@@ -1,53 +1,161 @@
 #!/usr/bin/env make
 #
-# 2011 makefile
+# IOCCC 2011 winning entry - zucker
+
+################################################################################
 #
-# Copyright (C) 2011, Landon Curt Noll, Simon Cooper, and Leonid A. Broukhis.
+# Regarding individual entries:
+#
+# IOCCC winning entry code may not work on your system.  Even with standards,
+# conditions and build environments change, especially when it comes to more
+# extreme code such you might find in an IOCCC winner.  Moreover, what was
+# allowed and liked in one IOCCC contest may no longer be liked/allowed in
+# later IOCCC years.
+#
+# Corrections on winning author and fixing typos in remarks are VERY WELCOME.
+#
+# GitHub pull requests are welcome:
+#
+# If you have a patch that might make running an entry work in modern Unix-like
+# environments, please create a GitHub pull request for the IOCCC judges to
+# consider.
+#
+# Suggestions and corrections regarding Makefiles, winning author information,
+# fixing typos in remarks, and code patches are welcome via opening a GitHub
+# issue or better yet, by creating a GitHub pull request for the IOCCC judges
+# to consider.  To form a GitHub issue or GitHub pull, please visit:
+#
+# https://github.com/ioccc-src/winner
+#
+################################################################################
+
+# This work by Landon Curt Noll and Leonid A. Broukhis is licensed under:
+#
+#	Creative Commons Attribution-ShareAlike 3.0 Unported License.
 #
-# Creative Commons Attribution-ShareAlike 3.0 Unported License.
 # See: http://creativecommons.org/licenses/by-sa/3.0/
 
 
-################
+#############################
-# tool locations
+# shell used by this Makefile
-################
+#############################
 #
 SHELL= bash
-CP= cp
-CPP= cpp
-GUNZIP= gunzip
-LD= ld
-MAKE= make
-RM= rm
-SED= sed
-TAR= tar
-TRUE= true
 
-# optimization
+#######################
+# common tool locations
+#######################
+#
+include ../../var.mk
+
+# Set X11_LIBDIR to the directory where the X11 library resides
+#
+#X11_LIBDIR= /usr/X11R6/lib
+#X11_LIBDIR= /usr/X11/lib
+X11_LIBDIR= /opt/X11/lib
+
+# Set X11_INCLUDEDIR to the directory where the X11 include files reside
+#
+#X11_INCDIR= /usr/X11R6/include
+#X11_INCDIR= /usr/X11/include
+X11_INCDIR= /opt/X11/include
+
+# Common C compiler warnings to silence
+#
+#CSILENCE=
+CSILENCE= -Wno-empty-body
+
+# Common C compiler warning flags
+#
+#CWARN= ${CSILENCE}
+#CWARN= -Wall ${CSILENCE}
+#CWARN= -Wall -Wextra ${CSILENCE}
+CWARN= -Wall -Wextra -pedantic ${CSILENCE}
+
+# Compiler standard
+#
+#CSTD=
+#CSTD= -ansi
+CSTD= -std=gnu11
+
+# Compiler bit architecture
+#
+# Some entries require 32-bitness:
+# ARCH= -m32
+#
+# Some entries require 64-bitness:
+# ARCH= -m64
+#
+# By default we assume nothing:
+#
+ARCH=
+
+# Defines that are needed to compile
+#
+#CDEFINE=
+CDEFINE= -D_BSD_SOURCE
+
+# Include files that are needed to compile
+#
+CINCLUDE=
+#CINCLUDE= -include stdlib.h
+#CINCLUDE= -include stdio.h
+#CINCLUDE= -include stdlib.h -include stdio.h
+#CINCLUDE= -I ${X11_INCDIR} -I ${X11_INCDIR}/X11
+#CINCLUDE= `${SDL2_CONFIG} --cflags`
+
+# Optimization
 #
 # Most compiles will safely use -O2.  Some can use only -O1 or -O.
 # A few compilers have broken optimizers or this entry make break
 # under those buggy optimizers and thus you may not want anything.
+# Reasonable compilers will allow for -O3.
 #
-OPT= -O2
+#OPT=
+#OPT= -O
+#OPT= -O1
+#OPT= -O2
+OPT= -O3
 
-# bitness
+# Default flags for ANSI C compilation
 #
-# Some entries require 32-bitness,
+CFLAGS= ${CSTD} ${CWARN} ${ARCH} ${CDEFINE} ${CINCLUDE} ${OPT}
-# other entries require 64-bitess.
-# By default we assume nothing.
-#
-ARCH=
 
-# default flags for ANSI C compilation
+# Libraries needed to build
 #
-CFLAGS= -Wall -W -ansi ${ARCH} ${OPT} -D_BSD_SOURCE -lm
+#LIBS=
+LIBS= -lm
+#LIBS= -L ${X11_LIBDIR} -lX11
+#LIBS= `${SDL2_CONFIG} --libs`
 
-# ANSI compiler
+# C compiler to use
-#
-# Set CC to the name of your ANSI compiler.
 #
 CC= cc
+#CC=clang
+#CC=gcc
+
+# Compiler add-ons or replacements for clang only
+#
+ifeq ($(CC),clang)
+#
+CSILENCE+= -Wno-comma -Wno-double-promotion -Wno-float-conversion \
+	-Wno-implicit-float-conversion -Wno-missing-prototypes \
+	-Wno-missing-variable-declarations -Wno-poison-system-directories \
+	-Wno-shadow -Wno-strict-prototypes
+#
+CWARN+= -Weverything
+#
+endif
+
+# Specific add-ons or replacements for gcc only
+#
+ifeq ($(CC),gcc)
+#
+#CSILENCE+=
+#
+#CWARN+=
+#
+endif
 
 
 ##############################
@@ -55,46 +163,85 @@ CC= cc
 ##############################
 #
 ENTRY= zucker
+PROG= ${ENTRY}
+#
+OBJ= ${PROG}.o
 DATA=
+TARGET= ${PROG}
+#
+ALT_OBJ=
+ALT_TARGET=
 
 
 #################
 # build the entry
 #################
 #
-all: ${ENTRY} ${DATA}
+all: data ${TARGET}
 	@${TRUE}
 
-${ENTRY}: ${ENTRY}.c
+.PHONY: all alt data everything clean clobber install \
-	${CC} ${CFLAGS} ${ENTRY}.c -o ${ENTRY}
+	love haste waste maker easter_egg sandwich \
+	supernova deep_magic magic charon pluto
+
+${PROG}: ${PROG}.c
+	${CC} ${CFLAGS} $< -o $@ ${LIBS}
 
 # alternative executable
 #
-alt:
+alt: data ${ALT_TARGET}
 	@${TRUE}
 
+# data files
+#
+data: ${DATA}
+	@${TRUE}
+
+# both all and alt
+#
+everything: all alt
+
 
 ###############
 # utility rules
 ###############
 #
-everything: all alt
-
 clean:
-	${RM} -f ${ENTRY}.o
+	${RM} -f ${OBJ} ${ALT_OBJ}
+	@-if [ -f indent.c ]; then \
+	    echo ${RM} -f indent.c; \
+	    ${RM} -f indent.c; \
+	fi
 
 clobber: clean
-	${RM} -f ${ENTRY}
+	${RM} -f ${TARGET} ${ALT_TARGET}
-
+	@-if [ -e sandwich ]; then \
-nuke: clobber
+	    ${RM} -f sandwich; \
-	@echo gnab gib!
+	    echo 'ate sandwich'; \
+	fi
 
 install:
-	@echo "Surely you're joking Mr. Feynman!"
+	@echo "Dr. Spock says that is not logical!"
+	@${TRUE}
 
-# backwards compatibility
+# you may be able to misunderstand the source by reading indent.c
 #
-build: all
+indent.c: ${PROG}.c
+	@if which "${GINDENT}" >/dev/null 2>&1; then \
+	    echo ${RM} -f $@; \
+	    ${RM} -f $@; \
+	    echo "${GINDENT} < $< > $@"; \
+	    ${GINDENT} < $< > $@; \
+	elif which "${INDENT}" >/dev/null 2>&1; then \
+	    echo ${RM} -f $@; \
+	    ${RM} -f $@; \
+	    echo "${INDENT} < $< > $@"; \
+	    ${INDENT} < $< > $@; \
+	else \
+	    echo "no intent tool found, ident $< yourself, sorry"; \
+	    echo "exit 1"; \
+	    exit 1; \
+	fi
 
 
 ##################
@@ -103,15 +250,79 @@ build: all
 #
 love:
 	@echo 'not war?'
+	@${TRUE}
 
 haste:
 	$(MAKE) waste
+	@${TRUE}
 
 waste:
-	@echo 'waste'
+	@echo 'haste'
+	@${TRUE}
+
+maker:
+	@echo 'Participate in a maker faire'
+	@${TRUE}
 
 easter_egg:
-	@echo you expected to mis-understand this $${RANDOM} magic
+	@echo "you expected to often misunderstand this $${RANDOM} magic"
-	@echo chongo '<was here>' "/\\oo/\\"
+	@echo "chongo '<was here>' /\\oo/\\"
-	@echo Readers shall not be disallowed from being unable to partly misunderstand this final echo.
+	@echo "Eggy"
+
+sandwich: easter_egg
+	@if [ `id -u` -eq 0 ]; then \
+	    echo 'Okay.'; \
+	    echo "$${RANDOM}`date +%s`$${RANDOM}" > $@; \
+	else \
+	    echo 'What? Make it yourself.'; \
+	    exit 1; \
+	fi
+
+# Understand the history of the Homebrew Computer Club
+# as well as the West Coast Computer Faire and
+# you might be confused different.  :-)
+#
+supernova: sandwich
+	@-if [ -r .code_anal ]; then \
+	    ${RM} -f .code_anal_v6; \
+	else \
+	    echo "planet deniers, like some members of the IAU, are so cute when they try to defend their logic"; \
+	fi
+	@echo "A $@ helps ${MAKE} the elements that help form planets"
 	@${TRUE}
+
+deep_magic: supernova
+	@-if [ -r .code_anal ]; then \
+	    ccode_analysis --deep_magic 7889066cdbdf09b0408021754586e895be641cc9be29e7eafd3ca65359541f17 \
+	    		   --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
+	else \
+	    echo "Wrong! Do it again!"; \
+	    sleep 2; \
+	    echo "Wrong! Do it again!"; \
+	    sleep 2; \
+	    echo "Wrong! Do it again!"; \
+	fi
+	@${TRUE}
+
+magic: deep_magic
+	@-if [ -r .code_anal ]; then \
+	    ccode_analysis --level 20003 --mode 5717175 --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
+	else \
+	    echo "If you don't eat yer meat, you can't have any pudding!"; \
+	    echo "How can you have any pudding if you don't eat yer meat?!"; \
+	fi
+	@${TRUE}
+
+# The IOCCC resident astronomer states
+#
+charon: magic
+	@echo "$@ is a dwarf planet"
+	@echo "dwarf is a type of planet"
+	@echo "therefore IAU, $@ is a planet"
+
+pluto: charon
+	${MAKE} charon
+	@echo "$@ is a dwarf planet"
+	@echo "dwarf is a type of planet"
+	@echo "therefore, $@ is a planet"
+	@echo "having lots of planets is good feature because supernovae can help ${MAKE} a lot of them"

2011/zucker/README.md

@@ -1,27 +1,31 @@
 # Most shiny
 
-Matt Zucker  
+    Matt Zucker  
-<mzucker1@swarthmore.edu>  
+    <mzucker1@swarthmore.edu>  
-<http://www.swarthmore.edu/NatSci/mzucker1/>  
+    <http://www.swarthmore.edu/NatSci/mzucker1/>  
 
+# To build:
 
-## Judges' comments:
+```sh
-### To build:
+make
-
+```
-    make zucker
 
 ### To run:
 
-    ./zucker > image.ppm
+```sh
+./zucker > image.ppm
+```
 
 ### Try:
 
-    ./zucker "Hello!!!" > hello.ppm
+```sh
-    ./zucker faster\! -preview > image2.ppm
+./zucker "Hello!!!" > hello.ppm
+./zucker faster\! -preview > image2.ppm
+```
 
-    # Display the PPM image with your favorite image viewer
+Display the PPM image with your favorite image viewer.
 
-### Selected Judges Remarks:
+## Judges' comments:
 
 The rendered image is centered and is output as a 600 by 220 pixel PPM.
 The vector font is proportional.
@@ -29,16 +33,17 @@ The vector font is proportional.
 This entry uses no local variables. None! At! All!
 
 ## Author's comments:
-An image generator
-==================
 
-What it does:
+### An image generator
--------------
+
+### What it does:
 
 This program makes pretty pictures.  To see the default output, try
 running
 
-        ./zucker > image.ppm
+```sh
+./zucker > image.ppm
+```
 
 On the author's 2.5 GHz MacBook Pro, this command takes approximately
 1 minute and 18 seconds to run -- your runtime may vary.  You will
@@ -53,19 +58,22 @@ reloads the image as it is rendered.)
 Aside from the default image, you may create your own by running the
 program as follows:
 
-        ./zucker "your text" > image.ppm
+```sh
+./zucker "your text" > image.ppm
+```
 
 To mitigate long runtimes, the program can be invoked in a "preview"
 mode by appending `-preview` to the command line arguments, like so:
 
-        ./zucker faster\! -preview > image.ppm
+```sh
+./zucker faster\! -preview > image.ppm
+```
 
 If your platform distinguishes between binary and text streams, you
 may need to insert some code to reopen standard output in binary mode
 at the start of `main`. An ASCII platform is assumed.
 
-Pedagogical value:
+### Pedagogical value:
-------------------
 
 This program is quite suitable for the inexperienced programmer, due
 to a number of considerations:
@@ -93,9 +101,7 @@ to a number of considerations:
     reflection ray at an object's surface, given the incoming
     direction and surface normal.
     
-
+### Further details (contains spoilers):
-Further details (contains spoilers):
-------------------------------------
 
 The program is not quite a traditional ray tracer, but a "sphere
 tracer" which uses distance fields to encode proximity to objects in
@@ -161,11 +167,10 @@ were not submitted as entries for this year's IOCCC, not because they
 lack obfuscation, but because neither is written in C (they are in C++
 and Python, respectively).
 
---------------------------------------------------------------------------------
+## Copyright:
-<!--
+
 (c) Copyright 1984-2012, [Leo Broukhis, Simon Cooper, Landon Curt Noll][judges] - All rights reserved
 This work is licensed under a [Creative Commons Attribution-ShareAlike 3.0 Unported License][cc].
 
 [judges]: http://www.ioccc.org/judges.html
 [cc]: http://creativecommons.org/licenses/by-sa/3.0/
--->