From 00193bbae8b6345b70632cdcec4b98cbe20e5fbf Mon Sep 17 00:00:00 2001 From: Joshua Goins Date: Sun, 6 Mar 2022 19:16:20 -0500 Subject: [PATCH] Hint at usages of the engine in README --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93dade5..4189c30 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,13 @@ Here is a selection of screenshots that provides a good sense of the graphical c The sibenik, sponza and buddha models shown are from the [McGuire Computer Graphics Archive](https://casual-effects.com/data/), any other models shown are created by me. ## Features - You can view a more comprehensive list of features [here](https://github.com/redstrate/prism/wiki/List-of-Features). ## Building There are instructions for Windows, Linux, and macOS targets in the [wiki](https://github.com/redstrate/prism/wiki). There is an example app provided in `example/`. If you want to build the tooling or the example, use the CMake options `BUILD_EXAMPLE` and `BUILD_TOOLS` respectively. + +## Usage +The ideal way to use it is by letting prism take over your main() and implementing an app_main() instead, +(and using `add_platform_executable` in CMake) but I'm working on letting developers use the engine as a regular library too. \ No newline at end of file