[doc] Updated project documentation in leu of Beta 1 release

This commit is contained in:
Geoffrey McRae
2019-05-23 20:13:41 +10:00
parent dba9764c5e
commit 76d58deefa
3 changed files with 142 additions and 13 deletions

View File

@@ -13,6 +13,14 @@ If you like this project and find it useful and would like to help out you can s
* [Paypal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ESQ72XUPGKXRY)
* BTC - 14ZFcYjsKPiVreHqcaekvHGL846u3ZuT13
## Documentation
Please also be sure to see the following files for more information
* [client/README.md](client/README.md)
* [c-host/README.md](c-host/README.md)
* [module/README.md](module/README.md)
## Obtaining and using Looking Glass
Please see https://looking-glass.hostfission.com/quickstart
@@ -24,18 +32,6 @@ Latest bleeding edge builds of the Windows host application can be obtained from
https://looking-glass.hostfission.com/downloads
## Key Bindings
By default Looking Glass uses the `Scroll Lock` key as the escape key for commands as well as the input capture mode toggle, this can be changed using the `-m` switch if you desire a different key.
Below are a list of current key bindings:
| Command | Description |
|-|-|
| <kbd>ScrLk</kbd> | Toggle cursor screen capture |
| <kbd>ScrLk</kbd>+<kbd>F</kbd> | Full Screen toggle |
| <kbd>ScrLk</kbd>+<kbd>I</kbd> | Spice keyboard & mouse enable toggle |
| <kbd>ScrLk</kbd>+<kbd>N</kbd> | Toggle night vision mode (EGL renderer only!) |
# Help and support
## Web