From 3c614946e0d6346d59a585a5d83deed3730fa804 Mon Sep 17 00:00:00 2001 From: doyle Date: Sun, 16 Jul 2023 18:01:29 +1000 Subject: [PATCH] dqn: Fix up some grammar --- readme.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index 433e537..3959d26 100644 --- a/readme.md +++ b/readme.md @@ -1,10 +1,10 @@ # Dqn -Personal standard library that provides allocator aware data structures, custom -memory allocators and various miscellaneous helpers for prototyping. The library -is a unity-build style library where data structures and functions are separated -by category into files for organisation. You only need to include `dqn.h` which -amalgamates all the files into one translation unit. +My personal standard library that provides allocator aware data structures, +custom memory allocators and various miscellaneous helpers for prototyping. The +library is a unity-build style library where data structures and functions are +separated by category into files for organisation. You only need to include +`dqn.h` which amalgamates all the files into one translation unit. ## Build @@ -18,7 +18,7 @@ header file include the header. `dqn.h` includes all other files and their declaration into your header. In *one* `.cpp` file define the macro to enable the implementation of the header in -the translation unit. +that translation unit. ```cpp #define DQN_IMPLEMENTATION @@ -31,9 +31,10 @@ directory where headers are located, e.g. `-I `. ## Customisation The headers provide macros to compile out sections that are not needed. This can -be useful to speed up compile times if you want a particular part of the -library. Each header contains a table-of-contents that denotes the macro to -define to disable that section that should be defined before the header include. +be useful to speed up compile times or reduce binary size if you only need +a particular part of the library. Each header contains a table-of-contents that +denotes the macro to define to disable that section that should be defined +before the header include. ```cpp #define DQN_NO_VARRAY // Disable virtual array container