aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-04 08:29:42 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-04 08:29:42 +0100
commit333b07775be1ef20fdb5909672c1e4dcabec1b40 (patch)
tree7116a85a80937fb63df85bb713c4b33eac7b3973
parent761330ff6ee1febb0ecb223b6244416248b7f894 (diff)
parent06f65659fc6ffde7cabd2135040cbfbf089e5a24 (diff)
Merge branch 'master' into loek/savemgr
-rw-r--r--contributing.md5
-rw-r--r--readme.md4
2 files changed, 7 insertions, 2 deletions
diff --git a/contributing.md b/contributing.md
index a6e5074..775119a 100644
--- a/contributing.md
+++ b/contributing.md
@@ -65,6 +65,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
- Only use member initializer lists for non-trivial types.
- C++-style structs should define default values for all non-trivial fields.
- Declare incomplete classes instead of including the relevant header where
diff --git a/readme.md b/readme.md
index 8ce6d78..7cf044f 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