redstrate/prism
Archived
1
Fork 0
Code Activity

Hint at usages of the engine in README

Browse source
This commit is contained in:
Joshua Goins 2022-03-06 19:16:20 -05:00
parent 570df75a55
commit 00193bbae8
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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.