doylet/Dqn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

dqn: Fix up some grammar

Browse Source
This commit is contained in:
doyle 2023-07-16 18:01:29 +10:00
parent 5fdb1aa1a4
commit 3c614946e0
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
readme.md
View File

@ -1,10 +1,10 @@
# Dqn # Dqn
Personal standard library that provides allocator aware data structures, custom My personal standard library that provides allocator aware data structures,
memory allocators and various miscellaneous helpers for prototyping. The library custom memory allocators and various miscellaneous helpers for prototyping. The
is a unity-build style library where data structures and functions are separated library is a unity-build style library where data structures and functions are
by category into files for organisation. You only need to include `dqn.h` which separated by category into files for organisation. You only need to include
amalgamates all the files into one translation unit. `dqn.h` which amalgamates all the files into one translation unit.
## Build ## Build
@ -18,7 +18,7 @@ header file include the header.
`dqn.h` includes all other files and their declaration into your header. In `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 *one* `.cpp` file define the macro to enable the implementation of the header in
the translation unit. that translation unit.
```cpp ```cpp
#define DQN_IMPLEMENTATION #define DQN_IMPLEMENTATION
@ -31,9 +31,10 @@ directory where headers are located, e.g. `-I <path/to/dqn/headers>`.
## Customisation ## Customisation
The headers provide macros to compile out sections that are not needed. This can 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 be useful to speed up compile times or reduce binary size if you only need
library. Each header contains a table-of-contents that denotes the macro to a particular part of the library. Each header contains a table-of-contents that
define to disable that section that should be defined before the header include. denotes the macro to define to disable that section that should be defined
before the header include.
```cpp ```cpp
#define DQN_NO_VARRAY // Disable virtual array container #define DQN_NO_VARRAY // Disable virtual array container