Jean Sirmai
1676f36674
We wanted to have an automated documentation for our project. We choose doxygen since this is a well-established project, with common standards. To generate the documentation, simply type `make docs` and open `docs/html/index.html`. The documentation zone actually contains: - archives: several files from past of the projects, historical purpose - GTK-docs: ressources on GTK internals and API - rtfm: first draft of a user manual - showcase: some pictures of the UI example, that were communicated on the Gem-graph discussion room (XMPP) - html: doxygen-generated docs
88 lines
1.9 KiB
Makefile
88 lines
1.9 KiB
Makefile
.PHONY: run clean install all docs
|
|
.DELETE_ON_ERROR: $(BINDIR)/Getting_Started_with_GTK
|
|
.DEFAULT_GOAL: all
|
|
|
|
CPUS ?= $(shell (nproc --all || sysctl -n hw.ncpu) 2>/dev/null || echo 1)
|
|
MAKEFLAGS += --jobs=$(CPUS)
|
|
|
|
CC=gcc
|
|
DOXYGEN=doxygen
|
|
CFLAGS=`pkg-config --cflags gtk4 epoxy glib-2.0 libxml-2.0`
|
|
LDFLAGS=`pkg-config --libs gtk4 epoxy glib-2.0 libxml-2.0` -lGL -lGLU -lm -lepoxy -lX11 -lGLEW
|
|
WARNINGS = -Wall
|
|
DEBUG = -ggdb -fno-omit-frame-pointer #-fdiagnostics-color=always -fsanitize=bounds -fstack-check
|
|
OPTIMIZE = -O3
|
|
|
|
BINDIR=bin
|
|
BUILDDIR=build
|
|
SRCDIR=src
|
|
DOCSDIR=docs
|
|
|
|
SOURCES = $(shell find $(SRCDIR) -type f -name "*.c")
|
|
OBJECTS = $(patsubst %.c,$(BUILDDIR)/%.o,$(SOURCES))
|
|
DEPENDENCIES = $(patsubst %.c,$(BUILDDIR)/%.d,$(SOURCES))
|
|
|
|
all: $(BINDIR)/gem-graph-client
|
|
|
|
-include /etc/os-release
|
|
|
|
#
|
|
# Directories
|
|
#
|
|
$(BUILDDIR):
|
|
@mkdir -p $@
|
|
@echo " MKDIR $@"
|
|
|
|
$(BINDIR):
|
|
@mkdir -p $@
|
|
@echo " MKDIR $@"
|
|
|
|
#
|
|
# Dependencies
|
|
#
|
|
-include $(DEPENDENCIES)
|
|
|
|
$(BUILDDIR)/%.d: %.c Makefile | $(BUILDDIR)
|
|
@mkdir -p $(shell dirname $@)
|
|
@$(CC) $(CFLAGS) -MM -MT $(@:%.d=%.o) -MF $@ $<
|
|
@echo " DEP $@"
|
|
|
|
#
|
|
# Main program
|
|
#
|
|
$(BINDIR)/gem-graph-client: $(OBJECTS) | $(BINDIR)
|
|
@$(CC) $(LDFLAGS) $(WARNINGS) $(DEBUG) $(OPTIMIZE) $^ -o $@
|
|
@echo " LD $@"
|
|
|
|
#
|
|
# Objects
|
|
#
|
|
$(BUILDDIR)/%.o: %.c Makefile | $(BUILDDIR)
|
|
@mkdir -p $(shell dirname $@)
|
|
@$(CC) $(CFLAGS) $(WARNINGS) $(DEBUG) $(OPTIMIZE) -c $< -o $@
|
|
@echo " CC $@"
|
|
|
|
#
|
|
# Virtual recipes
|
|
#
|
|
install:
|
|
@echo "Installing is not supported"
|
|
|
|
run: $(BINDIR)/gem-graph-client
|
|
$(BINDIR)/gem-graph-client
|
|
|
|
docs: $(SOURCES) $(DEPENDENCIES)
|
|
@$(DOXYGEN) $(DOCSDIR)/doxyfile
|
|
@echo " DOXYGEN $(DOCSDIR)/doxyfile"
|
|
|
|
clean:
|
|
@rm -rf $(BINDIR)
|
|
@echo " RM $(BINDIR)"
|
|
@rm -rf $(BUILDDIR)
|
|
@echo " RM $(BUILDDIR)"
|
|
|
|
|
|
# More docs :
|
|
# https://www.gnu.org/software/make/manual/
|
|
# accessoirement : https://blog.stephane-robert.info/docs/makefile/ & /docs/task/
|
|
|