docs: add readme and use in docs

This commit is contained in:
parker
2025-06-29 15:47:52 +01:00
parent b561e3f974
commit f6fae93559
2 changed files with 20 additions and 2 deletions

View File

@@ -965,7 +965,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = src/Engine
INPUT = src/Engine README.md
# This tag can be used to specify the character encoding of the source files
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1181,7 +1181,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the Doxygen output.
USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = README.md
# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common

18
README.md Normal file
View File

@@ -0,0 +1,18 @@
<h1 align="center">Enzo DCC</h1>
<div align="center">
<a href="https://github.com/ParkerBritt?tab=repositories&q=&type=&language=c%2B%2B&sort="><img src="https://parkerbritt.com/badge?label=C%2B%2B&icon=cplusplus&color=00599C"></a>
<a href="https://www.opengl.org/"><img src="https://parkerbritt.com/badge?label=opengl&icon=opengl&color=5586A4"></a>
<a href="https://www.qt.io/"><img src="https://parkerbritt.com/badge?label=qt&icon=qt&color=41CD52"></a>
</div>
Enzo is a node based 3D DCC tool.
<img src="https://github.com/user-attachments/assets/c1de2a74-fdd3-4d9c-8e8a-3c0183eab173">
> [!IMPORTANT]
> early work in progress
## Docs
Check out the api [here!](https://parkerbritt.github.io/enzo/)