diff options
| -rw-r--r-- | contributing.md | 4 | ||||
| -rw-r--r-- | lazy.mk | 33 | ||||
| -rw-r--r-- | makefile | 2 | ||||
| -rw-r--r-- | mwe/dynlink/exec/makefile | 1 | ||||
| -rw-r--r-- | mwe/dynlink/lib/makefile | 1 | ||||
| -rw-r--r-- | readme.md | 24 | ||||
| -rw-r--r-- | src/makefile | 2 | ||||
| -rw-r--r-- | test/makefile | 7 |
8 files changed, 24 insertions, 50 deletions
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 - @@ -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 @@ -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) - |