DOCS: added mkdocs support
parent
ca39483ce3
commit
4a7713142d
|
@ -1,4 +1,4 @@
|
|||
# Building {#building}
|
||||
# Building
|
||||
|
||||
## Linux
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Configuration {#configuration}
|
||||
# Configuration
|
||||
|
||||
## Variables
|
||||
|
||||
|
|
|
@ -1,8 +1,11 @@
|
|||
# Dependencies {#dependencies}
|
||||
# Dependencies
|
||||
|
||||
* cmake
|
||||
* ninja-build
|
||||
* postgre
|
||||
* postgresql
|
||||
|
||||
## Libraries
|
||||
|
||||
* development headers/libs for
|
||||
* glm
|
||||
* lua >= 5.3
|
||||
|
@ -11,9 +14,8 @@
|
|||
* libpq
|
||||
* enet
|
||||
* libuv
|
||||
* turbobadger
|
||||
* gtest
|
||||
* opencl
|
||||
* opencl (optional)
|
||||
* libuuid
|
||||
* qt (for the rcon tool)
|
||||
* mosquitto (optional)
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Game Design {#gamedesign}
|
||||
# Game Design
|
||||
|
||||
This is about an mmorpg in a fantasy like world.
|
||||
|
||||
|
|
|
@ -0,0 +1,18 @@
|
|||
# Welcome to vengi
|
||||
|
||||
This is a C++ voxel game engine and its tools. It includes a voxel editor with character animation support
|
||||
and loading/saving into a lot of voxel volume formats. There are other tools like e.g. a thumbnailer for
|
||||
your filemanager and a command line tool to convert between several voxel formats are included.
|
||||
|
||||
Find out more about features and status updates on my [twitter profile](https://twitter.com/MartinGerhardy).
|
||||
|
||||
The project source code is located at [github/mgerhardy/engine](https://github.com/mgerhardy/engine). We also
|
||||
provide debian and windows binaries here.
|
||||
|
||||
Join our [discord Server](https://discord.gg/AgjCPXy).
|
||||
|
||||
## Images
|
||||
|
||||
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/gliding-2020-02-23.png)
|
||||
|
||||
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/reflective_water_surface.png)
|
|
@ -1,4 +1,4 @@
|
|||
# Setup {#setup}
|
||||
# Setup
|
||||
|
||||
## PostgreSQL
|
||||
|
||||
|
|
|
@ -0,0 +1,23 @@
|
|||
site_name: vengi - voxel engine and its tools
|
||||
|
||||
docs_dir: docs
|
||||
site_dir: build/docs
|
||||
|
||||
theme:
|
||||
name: readthedocs
|
||||
highlightjs: true
|
||||
hljs_languages: [cpp]
|
||||
|
||||
markdown_extensions:
|
||||
- toc:
|
||||
toc_depth: 2
|
||||
|
||||
nav:
|
||||
- README.md
|
||||
- Basics:
|
||||
- Dependencies.md
|
||||
- Compilation.md
|
||||
- Setup.md
|
||||
- Configuration.md
|
||||
- Game Design:
|
||||
- GameDesign.md
|
Loading…
Reference in New Issue