getting-started needs some details

Paper-Cranes-Ltd / big2-stack

This is a middleware repository that eases up the work with BGFX, GLFW, IMGUI and GLM.

https://paper-cranes-ltd.github.io/big2-stack/

The Unlicense

38 stars 1 forks source link

getting-started needs some details #5

Open truedat101 opened 6 months ago

truedat101 commented 6 months ago

https://github.com/Paper-Cranes-Ltd/big2-stack/blob/main/docs/getting-started.md

BGFX is arguably one of the more complex to configure if you don't take defaults. And bgfx is like serving coffee or tea. Many things may need to be customized depending on the situation. I like the idea of something like big2 or bigg that provides more batteries and decisions for things to help getting started.

I am expecting to find:

default build instructions for win / mac / linux (I can help on linux and mac)
considerations for customizing (different backends for example, bgfx flags etc..)
known issues

object71 commented 6 months ago

I am accepting contributions to this repository. You can draft up a page for the getting-started.md if you are willing to work on this :)

truedat101 commented 6 months ago

Excellent. Let me go through the platforms to see what might be needed since the canvas is blank. I think currently I need to resolve the issues with a mac build (builds but doesn't render) and a linux build (doesn't build).

object71 commented 6 months ago

I have added a contributors guide https://paper-cranes-ltd.github.io/big2-stack/contributing.html

truedat101 commented 6 months ago

Great, on my todo list todo a review. I will retry my build on mac and go through the contributor guide before sending anything. I believe I probably need to just document the mac specific bgfx configuration needed.(prefer metal over GL).