From 4488699e555b9a19431a9001635036b0c1cacddf Mon Sep 17 00:00:00 2001 From: Ryan Pavlik Date: Wed, 21 Apr 2021 11:13:45 -0500 Subject: [PATCH] d/ultraleap_v2: Add missing copyright/license header, reflow, and fix markdownlint warnings. --- src/xrt/drivers/ultraleap_v2/readme.MD | 12 --------- src/xrt/drivers/ultraleap_v2/readme.md | 36 ++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 12 deletions(-) delete mode 100644 src/xrt/drivers/ultraleap_v2/readme.MD create mode 100644 src/xrt/drivers/ultraleap_v2/readme.md diff --git a/src/xrt/drivers/ultraleap_v2/readme.MD b/src/xrt/drivers/ultraleap_v2/readme.MD deleted file mode 100644 index 692d4ac02..000000000 --- a/src/xrt/drivers/ultraleap_v2/readme.MD +++ /dev/null @@ -1,12 +0,0 @@ -## Building -To build you need `Leap.h` and `LeapMath.h` in `/usr/local/include`; and `libLeap.so` in `/usr/local/lib`, and this should automatically build. - -## Running -To have the ultraleap driver successfully initialize, you need to have the Leap Motion Controller plugged in, and `leapd` running. Running `sudo leapd` in another terminal works but it may be slightly more convenient to have it run as a systemd service. - -## Configuring -Presumably, you're using this driver because you want to stick the Leap Motion Controller on the front of your HMD and have it track your hands. - -If you don't have a config file at ~/.config/monado/config_v0.json (or wherever you set `XDG_CONFIG_DIR`), your tracked hands will show up near the tracking origin and not move around with your HMD, which is probably not what you want. - -Instead you probably want to configure Monado to make your Leap Motion Controller-tracked hands follow around your HMD. There's an example of how to do this with North Star in `doc/example_configs/config_v0.json.northstar_lonestar`. If you're using a North Star headset, that should work but unless you're using the Lone Star NS variant you'll need to edit the offsets. If you're using some other HMD you'll have to edit the `tracker_device_serial` to be your HMD serial, and your own offsets. \ No newline at end of file diff --git a/src/xrt/drivers/ultraleap_v2/readme.md b/src/xrt/drivers/ultraleap_v2/readme.md new file mode 100644 index 000000000..7cb0d0b79 --- /dev/null +++ b/src/xrt/drivers/ultraleap_v2/readme.md @@ -0,0 +1,36 @@ +# About Monado's UltraLeap driver + + + +## Building + +To build you need `Leap.h` and `LeapMath.h` in `/usr/local/include`; and +`libLeap.so` in `/usr/local/lib`, and this should automatically build. + +## Running + +To have the ultraleap driver successfully initialize, you need to have the Leap +Motion Controller plugged in, and `leapd` running. Running `sudo leapd` in +another terminal works but it may be slightly more convenient to have it run as +a systemd service. + +## Configuring + +Presumably, you're using this driver because you want to stick the Leap Motion +Controller on the front of your HMD and have it track your hands. + +If you don't have a config file at `~/.config/monado/config_v0.json` (or +wherever you set `XDG_CONFIG_DIR`), your tracked hands will show up near the +tracking origin and not move around with your HMD, which is probably not what +you want. + +Instead you probably want to configure Monado to make your Leap Motion +Controller-tracked hands follow around your HMD. There's an example of how to do +this with North Star in `doc/example_configs/config_v0.json.northstar_lonestar`. +If you're using a North Star headset, that should work but unless you're using +the Lone Star NS variant you'll need to edit the offsets. If you're using some +other HMD you'll have to edit the `tracker_device_serial` to be your HMD serial, +and your own offsets.