From 1d86f5c341b70a657fdf45c12d4eaced92fdb00b Mon Sep 17 00:00:00 2001 From: Reece Wilson Date: Tue, 5 Oct 2021 21:03:13 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 148b55d..b6cd7ea 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ +## Aurora Interfaces This library implements the macros required to define Aurora style interfaces. Defines two classes. Implementable by SWIG, CppSharp, and classical OOP override event interface; and implementable by std::function for modern C++ and runtime language bindings respectively. The former is simply defined as a structure containing virtual methods as laid out by AUI_METHODS. Latterly, the interface is extended and mplemented by an array virtual override method defintions. -Example usage: -In your common header: + +## Example usage: + +#### In your common header: ``` #if defined(MY_LIB_GEN_BINDINGS) #define LIB_INTERFACE(name, list) AUI_INTERFACE_IMPL(name, list) @@ -10,7 +13,7 @@ In your common header: #endif ``` -In your public API: +#### In your public API: ``` LIB_INTERFACE(IInputMouseSubscriber, AUI_METHODS @@ -22,11 +25,12 @@ In your public API: ); ``` -In a dedicated translation unit: +#### In a dedicated translation unit: ``` #define MY_LIB_GEN_BINDINGS #include <...> ``` -Not recommended for small projects and/or people with a shred of sanity left \ No newline at end of file +##### Not recommended for small projects and/or people with a shred of sanity left +##### Possibly useful for API developers \ No newline at end of file