[*] Improve readme by readding the <...>

[*] Improve readme by readding the <...> include to indicate the user should include their public api to initialize the interfaces within that particular header
This commit is contained in:
Reece Wilson 2021-10-28 21:22:04 +00:00
parent d7cfbb6c7e
commit 1d158614bd

View File

@ -27,12 +27,14 @@ LIB_INTERFACE(IInputMouseSubscriber,
#define MY_LIB_GEN_BINDINGS #define MY_LIB_GEN_BINDINGS
#include <AuroraForEach.hpp> #include <AuroraForEach.hpp>
#include <AuroraInterfaces.hpp> #include <AuroraInterfaces.hpp>
#include <[MyPublicAPI].hpp>
``` ```
#### Usage: C++ inheritance (covers SWIG and CppSharp) #### Usage: C++ inheritance (covers SWIG and CppSharp)
``` ```
#include <AuroraForEach.hpp> #include <AuroraForEach.hpp>
#include <AuroraInterfaces.hpp> #include <AuroraInterfaces.hpp>
#include <[MyPublicAPI].hpp>
struct MyEventHandler : public IInputMouseSubscriber struct MyEventHandler : public IInputMouseSubscriber
{ {
@ -64,4 +66,4 @@ AuSPtr<IInputMouseSubscriber> handle = AuUnsafeRaiiToShared(&test);
* [AuroraForEach](https://git.reece.sx/AuroraSupport/AuroraForEach) [header only] * [AuroraForEach](https://git.reece.sx/AuroraSupport/AuroraForEach) [header only]
##### Not recommended for small projects and/or people with a shred of sanity left ##### Not recommended for small projects and/or people with a shred of sanity left
##### Possibly useful for API developers ##### Possibly useful for API developers