diff --git a/README.md b/README.md index 6bc509a..bb0aab9 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,43 @@ # Josh Graphics Library -# Goals +Yet Another C++ Rendering Toolkit + +![Static Badge](https://img.shields.io/badge/Lit-Based-%20) + +## Goals * Provide single-function-calls to render various graphics primitives in 2D and 3D. * Integrated directly with our other toolkits (ReWindow, J3ML) * Quick Rendering of Debug Text, Geometric Widgets, Textures, and so forth. -# Non-Goals +## Non-Goals * Full Rendering Engine * OpenGL/Vulkan Wrapper * Asset Loading & Management +## Features + +* Modern C++ (20) +* Little-to-no overhead +* No hand-holding +* No-frills, straight up just renders shapes and text. +* Integrates right into an existing OpenGL rendering system. + +## Usage + +Install instructions and code samples coming soon :tm: ! + +## Documentation + +Documentation is (sic: will be) automatically generated from latest commit and is hosted at https://doc.redacted.cc/jgl . + +## Contributing + +Contributions to JGL are welcome! If you find a bug, have a feature request, or would like to contribute code, please submit an issue or pull request to our repository! + +## License + +JGL is licensed under the Public Domain. See the LICENSE file for details. + +## Acknowledgements + +JGL is developed and maintained by Josh O'Leary @ Co from Redacted Software and contributors. Special thanks to Redacted. \ No newline at end of file