From 128969619a22dfc17a9ea35335c0d21c6ad0c954 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Thu, 10 Oct 2024 12:31:36 +0200 Subject: update contributing.md --- contributing.md | 5 +++++ readme.md | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/contributing.md b/contributing.md index 364e835..e5d4bd8 100644 --- a/contributing.md +++ b/contributing.md @@ -59,6 +59,11 @@ declaration instead of using the constructor. - Header files declare either a single class or symbols within a single namespace. +- Use of the `auto` type is not allowed, with the following exceptions: + - When naming the item type in a range-based for loop + - When calling template factory methods that explicitly name the return type + in the function call signature + - When fetching a singleton instance ## CMakeLists specific diff --git a/readme.md b/readme.md index 24bb66f..d095d74 100644 --- a/readme.md +++ b/readme.md @@ -5,10 +5,10 @@ This repository contains: |folder|content| |-|-| |`lib/`|third-party libraries as git submodules| -|`mwe/`|minimal working examples and proof-of-concepts| +|`mwe/`|minimal working examples and standalone proof-of-concepts (isolated from the engine)| |`src/crepe/`|game engine source code| |`src/test/`|unit tests| -|`src/example/`|standalone examples using game engine| +|`src/example/`|standalone examples or proof-of-concepts using game engine internals| ## Compilation -- cgit v1.2.3