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: Start a writing a driver document page

Browse source
This commit is contained in:
Jakob Bornecrantz 2020-02-26 12:01:30 +00:00
parent a228c3efff
commit 265425a9bc
2 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/mainpage.md
View file

@ -4,6 +4,10 @@ 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
getting started information and general documentation.
## Useful pages
* @ref md_writing-a-new-driver (**not complete**)
## Source layout
* src/xrt/include - @ref xrt_iface defines the internal interfaces of Monado.

13
doc/writing-a-new-driver.md Normal file
View file

@ -0,0 +1,13 @@
# Writing a new driver
This document will tell you in broad strokes what you need to do to create a
driver in Monado. Like the many ones already in there @ref drv. It is not a step
by step guide to making a driver. Also what you need to do can vary a lot
depending on the type of hardware you are adding a driver for and the level of
features you want.
## Map
The first components you will be interacting with is @ref st_prober find the
hardware devices and setup a working system, along with the @ref aux code that
provides various helpers. You can look at other @ref drv on how to start.