Initial commit

GamesTrap · Nov 4, 2023 · 880ef5d · 880ef5d
commit 880ef5d
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+docs/_build/
+!/GeneratorScripts/**
+gitui
+*.TODO
+.modules/generatedocs/api/**
+.modules/generatedocs/doxygen_docs/**
+.penv/**
+Coverage/
diff --git a/Branding/TRAP.gif b/Branding/TRAP.gif
diff --git a/Branding/TRAPBlackLogoMedia2048x2048.png b/Branding/TRAPBlackLogoMedia2048x2048.png
diff --git a/Branding/TRAPWhiteLogoMedia2048x2048.png b/Branding/TRAPWhiteLogoMedia2048x2048.png
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1 @@
+This repository uses the TRAP™ Engine End User License Agreement which can be found at https://gamestrap.github.io/TRAP/pages/eula.html
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# TRAP™ Docs
+
+<p align="center">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="Branding/TRAPWhiteLogoMedia2048x2048.png">
+        <img alt="TRAP™ logo" src="Branding/TRAPBlackLogoMedia2048x2048.png" width="375" height="204">
+    </picture>
+</p>
+
+[![Build-CI](https://github.com/GamesTrap/TRAP/actions/workflows/build.yml/badge.svg)](https://github.com/GamesTrap/TRAP/actions/workflows/build.yml)
+[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/GamesTrap/TRAP)](https://github.com/GamesTrap/TRAP)
+[![GitHub repo size](https://img.shields.io/github/repo-size/GamesTrap/TRAP)](https://github.com/GamesTrap/TRAP)
+[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/GamesTrap/TRAP?include_prereleases)](https://github.com/GamesTrap/TRAP/releases)
+[![GitHub All Releases](https://img.shields.io/github/downloads/GamesTrap/TRAP/total)](https://github.com/GamesTrap/TRAP/releases)
+[![GitHub issues](https://img.shields.io/github/issues/GamesTrap/TRAP)](https://github.com/GamesTrap/TRAP/issues?q=is%3Aopen+is%3Aissue)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/GamesTrap/TRAP)](https://github.com/GamesTrap/TRAP/pulls?q=is%3Aopen+is%3Apr)
+[![GitHub](https://img.shields.io/badge/license-TRAP%E2%84%A2%20Engine%20EULA-lightgrey)](https://gamestrap.github.io/TRAP/pages/eula.html)
+
+TRAP™ is a cross-platform, high performance game engine currently in development.  
+
+This repository only contains documentation files.
+
+## License
+
+This repository uses the [TRAP™ Engine End User License Agreement](https://gamestrap.github.io/TRAP/pages/eula.html)
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,8 @@
+# Security
+
+## Reporting security vulnerabilities
+
+If you've found a security vulnerability in TRAP™, please do not create an issue on
+the GitHub issue tracker as it will be visible publicly.
+
+Instead, send an email to <[email protected]>.
diff --git a/docs/.nojekyll b/docs/.nojekyll
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This repository uses the TRAP™ Engine End User License Agreement which can be found at https://gamestrap.github.io/TRAP/pages/eula.html