# vulkan-renderer

**Repository Path**: vulkan3d/vulkan-renderer

## Basic Information

- **Project Name**: vulkan-renderer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-12
- **Last Updated**: 2024-04-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

***************
vulkan-renderer
***************

|language| |platforms| |github actions| |readthedocs| |discord| |license|

.. image:: documentation/source/images/inexor-banner.svg


FAQ and documentation
#####################

Quickstart: `Building Instructions`_ (`Windows`_/`Linux`_) & `Getting started`_

.. _Building Instructions: https://inexor-vulkan-renderer.readthedocs.io/en/latest/development/building.html
.. _Windows: https://inexor-vulkan-renderer.readthedocs.io/en/latest/development/building.html#building-windows
.. _Linux: https://inexor-vulkan-renderer.readthedocs.io/en/latest/development/building.html#building-linux
.. _Getting started: https://inexor-vulkan-renderer.readthedocs.io/en/latest/development/getting-started.html


Inexor is an open-source project which combines modern C++ with Vulkan API.

Our current main objective is the development of a new 3d octree game engine.

`Click here <https://inexor-vulkan-renderer.readthedocs.io/en/latest/>`__ to read our faq and documentation.

Inexor is licensed under the `MIT license <https://github.com/inexorgame/vulkan-renderer/blob/main/LICENSE>`__.


Sponsors
########

Special thanks to `JetBrains <https://www.jetbrains.com/?from=github.com/inexorgame>`__ for providing us with CLion licenses!


.. image:: documentation/source/images/icon_CLion.svg
   :width: 150px


.. Badges.

.. |language| image:: https://img.shields.io/badge/language-C%2B%2B20-brightgreen

.. |platforms| image:: https://img.shields.io/badge/platforms-Linux%20%26%20Windows-brightgreen

.. |github actions| image:: https://img.shields.io/github/actions/workflow/status/inexorgame/vulkan-renderer/build.yml?branch=main
   :target: https://github.com/inexorgame/vulkan-renderer/actions?query=build.yml

.. |discord| image:: https://img.shields.io/discord/698219248954376256?logo=discord
   :target: https://discord.com/invite/acUW8k7

.. |license| image:: https://img.shields.io/github/license/inexorgame/vulkan-renderer?color=brightgreen
   :target: https://inexor-vulkan-renderer.readthedocs.io/en/latest/license/main.html

.. |downloads| image:: https://img.shields.io/github/downloads/inexorgame/vulkan-renderer/total?color=brightgreen

.. |readthedocs| image:: https://readthedocs.org/projects/inexor-vulkan-renderer/badge/?version=latest
   :target: https://inexor-vulkan-renderer.readthedocs.io