mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-02-05 13:28:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Fix typo and markdown-lint warnings.

Browse source
This commit is contained in:
Ryan Pavlik 2020-05-26 12:03:57 -05:00 committed by Jakob Bornecrantz
parent 86b375409b
commit 40c0ef74b3
1 changed files with 16 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
doc/mainpage.md
View file

@ -1,28 +1,27 @@
# Monado
This documentation is intended for developers wanting to dive into the code of
Monado. And assumes that you have read [README.md][], the file also holdss
Monado. And assumes that you have read [README.md][], the file also holds
getting started information and general documentation.
## Useful pages
* @ref md_CHANGELOG - If this is the web version of the docs, the changelog
also includes a section for changes that have not yet been in a tagged
release.
* @ref md_writing-a-new-driver (**not complete**)
* @ref md_CHANGELOG - If this is the web version of the docs, the changelog
also includes a section for changes that have not yet been in a tagged
release.
* @ref md_writing-a-new-driver (**not complete**)
## Source layout
* src/xrt/include - @ref xrt_iface defines the internal interfaces of Monado.
* src/xrt/drivers - Hardware @ref drv.
* src/xrt/compositor - @ref comp code for doing distortion and driving the
display hardware of a device.
* src/xrt/state_trackers/oxr - @ref oxr, implements the OpenXR API.
* src/xrt/state_trackers/gui - @ref gui, various helper and debug GUI code.
* src/xrt/auxiliary - @ref aux and other larger components, like
@ref aux_tracking and @ref aux_math.
* src/xrt/targets - glue code and build logic to produce final binaries.
* src/external - a small collection of external code and headers.
* src/xrt/include - @ref xrt_iface defines the internal interfaces of Monado.
* src/xrt/drivers - Hardware @ref drv.
* src/xrt/compositor - @ref comp code for doing distortion and driving the
display hardware of a device.
* src/xrt/state_trackers/oxr - @ref oxr, implements the OpenXR API.
* src/xrt/state_trackers/gui - @ref gui, various helper and debug GUI code.
* src/xrt/auxiliary - @ref aux and other larger components, like @ref
aux_tracking and @ref aux_math.
* src/xrt/targets - glue code and build logic to produce final binaries.
* src/external - a small collection of external code and headers.
[README.md]: https://gitlab.freedesktop.org/monado/monado