Tweaks to the docs.

This commit is contained in:
Relintai 2024-01-21 13:01:24 +01:00
parent 4cece05e74
commit 3f82f33b40
2 changed files with 70 additions and 27 deletions

View File

@ -1,10 +0,0 @@
# Markdeep
Official public mirror of Markdeep by Morgan McGuire. BSD License.
See the [Markdeep homepage](https://casual-effects.com/markdeep) for documentation and a hosted
version.
I do not accept pull requests through this repository because this is a
mirror of the private repo. Email <morgan@casual-effects.com> to discuss features.
#1.16

View File

@ -1,26 +1,14 @@
<meta charset="utf-8">
**SFW Docs**
SFW - Simple Framework - https://github.com/Relintai/sfw
Simple c++ app / game framework inspired by the single file c game engines
and libraries, especially [FWK](https://github.com/r-lyeh/FWK).
It was designed to help with teaching programming, but it turns out it's pretty useful for other projects aswell.
**Modules**: Core, Object, Render Core, Render Immediate, Render Objects
This library / framework is:
- Simple to compile.
- Simple to initialize.
- Simple to use.
- Supports windowing and opengl (ES2).
- Modular (within reason).
- It is desktop only (Windows, Linux, OSX) for now (most code is multiplatform though).
Also:
- The codebase is simple and easy to read.
- Comes with it's own container classes and memory management.
- Comes as 2 (or 3) merged files. (This way it's actually simpler to use and setup compared to if it was single header!)
- It does not use exceptions.
Compile
COMPILE
====================================================================================
$FILE_Compilation_Renderer$
@ -1337,7 +1325,7 @@ ADVANCED
There are a few remaining classes that were omitted from this document (Like allocators, hashers etc.),
as you will normally won't need them. (If you do, you will likely just need to rread the source anyway.)
Licenses
LICENSES
====================================================================================
SFW
@ -1510,6 +1498,71 @@ CORE
$LICENSES_Renderer$
DOCUMENTATION
<a name="LICENSE_MARKDEEP"></a>
<details><summary>Markdeep</summary>
This documentation was generated using markdeep:
https://casual-effects.com/markdeep
**Markdeep is open source. You may use, extend, and redistribute Markdeep without charge under the terms of the BSD license:**
Copyright 2015-2019, Morgan McGuire
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
**Markdeep includes highlight.js, so you are also bound by its BSD license:**
Copyright (c) 2006, Ivan Sagalaev
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
* Neither the name of highlight.js nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</details>
<script>markdeepOptions = {tocStyle:'long', definitionStyle:'long', linkAPIDefinitions: true};</script>
<style>$MARKDEEP_THEME$</style>