From 44affb6635359ef2f619562800165ccfff438ae4 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Sat, 21 Sep 2024 15:35:05 +0200
Subject: `make format`

---
 mwe/dynlink/exec/main.c | 1 -
 mwe/dynlink/lib/lib.c   | 5 +----
 mwe/dynlink/lib/lib.h   | 1 -
 3 files changed, 1 insertion(+), 6 deletions(-)

(limited to 'mwe/dynlink')

diff --git a/mwe/dynlink/exec/main.c b/mwe/dynlink/exec/main.c
index e3f458a..2bbdc20 100644
--- a/mwe/dynlink/exec/main.c
+++ b/mwe/dynlink/exec/main.c
@@ -5,4 +5,3 @@ int main() {
 
 	return 0;
 }
-
diff --git a/mwe/dynlink/lib/lib.c b/mwe/dynlink/lib/lib.c
index 930e403..c7a78e4 100644
--- a/mwe/dynlink/lib/lib.c
+++ b/mwe/dynlink/lib/lib.c
@@ -1,6 +1,3 @@
 #include <stdio.h>
 
-void library_function() {
-	printf("%s\n", __PRETTY_FUNCTION__);
-}
-
+void library_function() { printf("%s\n", __PRETTY_FUNCTION__); }
diff --git a/mwe/dynlink/lib/lib.h b/mwe/dynlink/lib/lib.h
index 068f07d..093eadb 100644
--- a/mwe/dynlink/lib/lib.h
+++ b/mwe/dynlink/lib/lib.h
@@ -1,4 +1,3 @@
 #pragma once
 
 void library_function();
-
-- 
cgit v1.2.3


From a12702c912ae0ce96c754ffcb2ab5d901c504b65 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Sat, 21 Sep 2024 15:43:14 +0200
Subject: remove lazy.mk and update readme

---
 contributing.md           |  4 ++--
 lazy.mk                   | 33 ---------------------------------
 makefile                  |  2 --
 mwe/dynlink/exec/makefile |  1 -
 mwe/dynlink/lib/makefile  |  1 -
 readme.md                 | 24 ++++++++++++++++++++++--
 src/makefile              |  2 --
 test/makefile             |  7 -------
 8 files changed, 24 insertions(+), 50 deletions(-)
 delete mode 100644 lazy.mk
 delete mode 100644 mwe/dynlink/exec/makefile
 delete mode 100644 mwe/dynlink/lib/makefile
 delete mode 100644 src/makefile
 delete mode 100644 test/makefile

(limited to 'mwe/dynlink')

diff --git a/contributing.md b/contributing.md
index 40e1edd..832667d 100644
--- a/contributing.md
+++ b/contributing.md
@@ -16,8 +16,9 @@
 
 # Code style
 
-- Formatting nitty-gritty is handled by clang-format/clang-tidy
 - ASCII only
+- Formatting nitty-gritty is handled by clang-format/clang-tidy (run `make
+  format` in the root folder of this repository to format all sources files)
 - When using libraries of which the header include order is important, make
   sure to separate the include statements using a blank line (clang-format may
   sort include statements, but does not sort across empty lines).
@@ -32,7 +33,6 @@
 # Documentation
 
 - All documentation is written in U.S. English
-- TODO
 
 # Libraries
 
diff --git a/lazy.mk b/lazy.mk
deleted file mode 100644
index a591fd5..0000000
--- a/lazy.mk
+++ /dev/null
@@ -1,33 +0,0 @@
-# NOTE: CMAKE IS THE PRIMARY BUILD SYSTEM FOR THIS PROJECT. THIS FILE IS
-# PROVIDED PURELY FOR CONVENIENCE, AND SHOULD NOT BECOME AN ESSENTIAL PART OF
-# THE BUILD SYSTEM!
-
-BUILD_DIR ?= build
-TARGET ?= $(BUILD_DIR)/main
-
-# always generate fresh build rules when cmake is re-run
-CMFLAGS += --fresh
-# make cmake shut up
-CMFLAGS += --log-level WARNING
-CMFLAGS += -Wno-deprecated
-
-.PHONY: FORCE
-
-all: FORCE $(TARGET)
-
-$(BUILD_DIR)/build.ninja: CMakeLists.txt
-	@mkdir -p $(BUILD_DIR)
-	@cmake -B $(BUILD_DIR) -G Ninja $(CMFLAGS)
-
-$(TARGET): $(BUILD_DIR)/build.ninja FORCE
-	@ninja -C $(BUILD_DIR)
-
-clean: FORCE
-	$(RM) -r $(BUILD_DIR)
-
-# Forward any unknown targets to Ninja
-ifneq ($(MAKECMDGOALS),)
-%::
-	@ninja -C $(BUILD_DIR) $@
-endif
-
diff --git a/makefile b/makefile
index 3792250..737e7a8 100644
--- a/makefile
+++ b/makefile
@@ -1,5 +1,3 @@
-all: $(TARGET) # TARGET is defined in lazy.mk (build/main)
-
 .PHONY: FORCE
 
 doxygen: Doxyfile FORCE
diff --git a/mwe/dynlink/exec/makefile b/mwe/dynlink/exec/makefile
deleted file mode 100644
index eec7c61..0000000
--- a/mwe/dynlink/exec/makefile
+++ /dev/null
@@ -1 +0,0 @@
-include ../../../lazy.mk
diff --git a/mwe/dynlink/lib/makefile b/mwe/dynlink/lib/makefile
deleted file mode 100644
index eec7c61..0000000
--- a/mwe/dynlink/lib/makefile
+++ /dev/null
@@ -1 +0,0 @@
-include ../../../lazy.mk
diff --git a/readme.md b/readme.md
index 4974694..f3aab09 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,26 @@
 # crêpe
 
-systems programming in c++ minor engine
+This repository contains:
 
-please read [contributing.md](./contributing.md)
+|folder|content|
+|-|-|
+|`lib/`|third-party libraries as git submodules|
+|`mwe/`|minimal working examples and proof-of-concepts|
+|`src/crepe/`|game engine source code|
+|`test/`|game engine unit tests|
+
+## Compilation
+
+This repository uses CMake (the makefile in the root of this repository is for
+running auxiliary tasks only). Make sure you have initialized and updated the
+submodules before compiling.
+
+## Documentation
+
+API documentation is done using Doxygen. To generate the docs, run `make
+doxygen`.
+
+## Code style
+
+Please read [contributing.md](./contributing.md).
 
diff --git a/src/makefile b/src/makefile
deleted file mode 100644
index 8352615..0000000
--- a/src/makefile
+++ /dev/null
@@ -1,2 +0,0 @@
-include ../lazy.mk
-
diff --git a/test/makefile b/test/makefile
deleted file mode 100644
index 7aeee34..0000000
--- a/test/makefile
+++ /dev/null
@@ -1,7 +0,0 @@
-TARGET = $(BUILD_DIR)/test
-
-include ../lazy.mk
-
-test: $(TARGET) FORCE
-	$(TARGET)
-
-- 
cgit v1.2.3