Commit graph

178 commits

Author SHA1 Message Date
Geoffrey McRae
7275f249c9 [doc] fix another typo 2022-09-18 12:22:06 +10:00
Geoffrey McRae
de5030f564 [doc] fix my inabillity to spell :) 2022-09-18 12:21:11 +10:00
Geoffrey McRae
f489006531 [doc] reorder install to before usage and change information re IVSHMEM 2022-09-18 12:17:05 +10:00
Geoffrey McRae
571a5da50f [doc] add requirements page 2022-09-18 12:12:49 +10:00
Geoffrey McRae
76d2c69b46 [doc] allow monero (XMR) crypto addresses 2022-05-15 17:23:47 +10:00
Geoffrey McRae
febc2ec980 [doc] add XMR to the list of valid words 2022-05-15 17:20:53 +10:00
Geoffrey McRae
d8f2125543 [common/doc] add monero (XMR) donation address 2022-05-15 16:47:57 +10:00
Jonathan Rubenstein
aec2c78bd2 [doc] usage: Update Full Command Line Options 2022-05-15 16:42:27 +10:00
Jonathan Rubenstein
5797fbb4e5 [doc] usage: Move Command Line Options to the top
Also reformats common parameters, and lists them at the top man page
style
2022-05-15 16:42:27 +10:00
Jonathan Rubenstein
836e7ab998 [doc] build: Change link text leading to client_install 2022-05-15 16:42:27 +10:00
Jonathan Rubenstein
0759a7664b [doc] build: Change Client Building notes to full cmake commands
This may help novices or people who have trouble constructing the commands
themselves
2022-05-15 16:42:27 +10:00
Jonathan Rubenstein
0db17f803b [doc] build: Adjust flow of Client Building section 2022-05-15 16:42:27 +10:00
Jonathan Rubenstein
4d57671bf1 [doc] usage: Move client install instructions to install.rst 2022-05-15 16:42:27 +10:00
Jonathan Rubenstein
30780ce445 [doc] Create usage.rst from install.rst
No edits
2022-05-15 16:42:27 +10:00
Geoffrey McRae
d0b3c09456 [doc] build: add missing audio dependencies 2022-01-27 18:03:11 +11:00
Jonathan Rubenstein
aba30e9541 [doc] build: Add source comment for listing deps 2022-01-20 17:49:35 +11:00
Geoffrey McRae
142902b7b3 [doc] fix typo and add Debian to the word list 2021-12-28 19:07:33 +11:00
Geoffrey McRae
192fb1cdc7 [doc] add link to the wiki for dependencies on other distributions
ref #909
2021-12-28 19:04:24 +11:00
Jonathan Rubenstein
f53adc7a05 [doc] build: Fix apt command overflowing page 2021-12-28 18:50:56 +11:00
Jonathan Rubenstein
9ff476bd09 [doc] Minor cleanup to release spelling check
Co-authored-by: Guanzhong Chen <quantum2048@gmail.com>
2021-12-27 09:23:31 +11:00
Jonathan Rubenstein
6ef3fea05e [doc] Version no longer gets spellchecked 2021-12-27 09:23:31 +11:00
Geoffrey McRae
90dd1f3913 [client] audio/pa: added initial pulseaudio implementation 2021-12-26 18:22:51 +11:00
Jonathan Rubenstein
a8ddf72318 [doc] conf: Fix typo in release git-describe command
We got the gist of it, but in the end, didn't git it right.
2021-12-26 14:12:39 +11:00
Jonathan Rubenstein
5d9db8b2f5 [docs] all: Change nav background from transparent to explicit 2021-12-26 13:57:05 +11:00
Jonathan Rubenstein
672cd246ab [docs] all: Fix mobile layout 2021-12-26 13:57:05 +11:00
Jonathan Rubenstein
936688ddac [doc] all: Center content when there's room 2021-12-26 13:28:40 +11:00
Jonathan Rubenstein
ff6c46f7ca [docs] all: Switch to sphinx-readthedocs-theme
From https://github.com/readthedocs/sphinx_rtd_theme
2021-12-26 12:46:23 +11:00
Quantum
4dccd725bf [doc] automatically detect version
We prefer the VERSION file if available, otherwise falling back to
querying version directly from git.
2021-12-26 12:08:24 +11:00
Geoffrey McRae
e810577317 [client] audio: initial addition of PipeWire audio support via SPICE 2021-12-26 11:09:42 +11:00
Jonathan Rubenstein
74444f8eed [docs] Minor semantic spit and polish
Co-authored-by: Guanzhong Chen <quantum2048@gmail.com>
Co-authored-by: Netboy3 <1472804+netboy3@users.noreply.github.com>
2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
6c43650cd3 [doc] spelling fixes 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
181ee2b4f5 [doc] module: Kernel Module polish 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
5bef733647 [doc] install: Update command line options 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
22cef47bc4 [doc] install: Overlay Filter config polish 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
5b25e20a2e [doc] install: Overlay Mode polish 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
bb5c7a222c [doc] conf: Whitespace 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
39ea6b0587 [doc] install: Config file loading polish 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
ddc6cb5277 [doc] obs: Install polish 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
b13a79880b [doc] faq: GNOME on Wayland polish 2021-12-26 10:02:07 +11:00
Jonathan Rubenstein
53fdc2e148 [docs] build: Better flow for Wayland tip 2021-12-26 10:02:07 +11:00
Netboy3
d6eb72331c [doc] module: Bring back older style XML
Older libvirt and QEMU require older style config
so put it back with version instructions.
2021-12-24 10:24:57 +11:00
Netboy3
9d47ca4f12 [doc] module: Modify libvirt commandline block to use JSON
Latest versions of QEMU are running out of PCIe mapping
through libvirt as the commandline device is mapping
ivshmem before other root devices.
Use JSON style configuration in the commandline block.
JSON arguments are loaded after all regular ones
and will guarantee to get loaded after all other libvirt mapped
PCIe devices.
2021-12-21 15:38:28 +11:00
jonpas
a6720db749 [docs] obs: fix installation instructions grammar
regression in bc022c77f4
2021-12-14 21:19:25 +11:00
Geoffrey McRae
bc022c77f4 [docs] obs: update instructions to make use of USER_INSTALL 2021-11-22 10:42:46 +11:00
Jonathan Rubenstein
6a898c1e7c [doc] install: Add instructions to disable memballoon in libvirt 2021-10-21 08:49:01 +11:00
Quantum
0990689df5 [doc] spelling: add "dejavu" to word list 2021-10-20 17:13:29 +11:00
Quantum
db0e03328c [doc] build: update dependencies for post-B4 changes 2021-10-20 16:58:55 +11:00
Jonathan Rubenstein
c5f71d18c4 [doc] module: Add unloading note for manual install 2021-10-20 11:31:18 +11:00
Jonathan Rubenstein
84a43fb651 [doc] Move DKMS above manual and mark recommended 2021-10-20 11:31:18 +11:00
Quantum
c9e8de334a [doc] module: make cgroups configuration more visible 2021-10-18 16:17:52 +11:00
Netboy3
c3d2ad92c5 [client] Change default grabKeyboardOnFocus to false 2021-10-15 11:36:38 +11:00
Jonathan Rubenstein
7ce7dec272 [doc] build: Add new build deps to apt-get 2021-10-15 11:36:18 +11:00
Quantum
5fbb34f8f3 [doc] add upscale/downscale and related words to dictionary 2021-09-04 17:23:13 +10:00
Quantum
20acb9002a [doc] install: fix missing new line warning 2021-09-04 13:35:08 +10:00
Quantum
4ee83a2b31 [client] ci: check --help spelling 2021-09-04 13:31:55 +10:00
Quantum
909a9a903f [doc] lgspell: allow spell checking arbitrary text 2021-09-04 13:31:55 +10:00
Quantum
753b44e34f [doc] support building with spell check 2021-09-04 13:30:51 +10:00
Netboy3
924bd9e543 [doc] Correct a few spelling mistakes 2021-09-04 13:27:35 +10:00
Netboy3
c4eadda389 [doc] install: Add Configuration Widget section
Add a section to cover the configuration widget, the
various tabs and settings and the new post-processing
filter stack.
2021-09-04 13:27:35 +10:00
Netboy3
f563e67e19 [doc] install: Remove scale toggle from key bindings 2021-09-04 13:27:35 +10:00
Netboy3
d7e4536e57 [doc] install: Add additional command line options
Add wayland:fractionScale and reorder options.
2021-09-04 13:27:35 +10:00
Quantum
0b70aa49d0 [doc] add documentation about libdecor 2021-08-21 23:02:20 +10:00
Netboy3
68eaf46d7c [doc] index: Modify Level1Techs URL to use a redirect 2021-08-05 12:40:17 +10:00
Netboy3
bae19cb130 [doc] install: Add Overlay Mode section 2021-08-03 01:12:35 +10:00
Netboy3
db501f689f [doc] install: Add $XDG_CONFIG_HOME/looking-glass/client.ini
* Add $XDG_CONFIG_HOME/looking-glass/client.ini to the list of
  config files
* Add a paragraph explaining config load and merge order
2021-08-03 01:12:35 +10:00
Netboy3
b8561cab0a [doc] install: Add win:jitRender command line option 2021-08-03 01:12:35 +10:00
Geoffrey McRae
7912d268e9 [doc] add libxpresent-dev as a new build dep for the client 2021-08-03 00:04:05 +10:00
Netboy3
2e0f765190 [doc] install: Update overlay mode keybinding 2021-08-01 12:11:02 +10:00
Geoffrey McRae
5e2dd589a1 [client] x11: implement cursor support for the imgui overlay
This commit adds libxcursor to the dependencies for X11.
2021-07-31 18:23:05 +10:00
Netboy3
d9a3b6523c [doc] install: Update client keybindings and command line options 2021-07-31 14:54:40 +10:00
Quantum
42d8f31eba [client] imgui: use ES 3.0 and remove glew dependency
If we specifically tell ImGui's OpenGL 3.x backend to target OpenGL ES 3.0,
then no extension loader is necessary.
2021-07-18 18:50:12 +10:00
Quantum
38a018ebfa [doc] build: remove mentions of SDL 2021-07-18 10:34:41 +10:00
Geoffrey McRae
f08163fd72 [client] imgui: added imgui to the client and OpenGL/EGL renderers 2021-07-17 21:09:51 +10:00
Jonathan Rubenstein
25c88a1c6c [doc] faq: Correct misinformed question about mouse warp issue 2021-07-17 15:20:22 +10:00
Jonathan Rubenstein
ed717351cf [doc] faq: Partial revert of fa871e9 to include registry hack
Expected to be fixed in B5
2021-07-16 00:47:22 +10:00
Jonathan Rubenstein
4658244686 [doc] build: Revise client build dependencies for B4 2021-07-16 00:47:22 +10:00
Jonathan Rubenstein
7083b73720 [doc] faq: B4-rc2 touchups 2021-07-10 13:13:23 +10:00
Jonathan Rubenstein
511adbba68 [doc] module: dkms example has explicit "."
This works in dash, so should be portable to most shells.
Will hopefully help users not misinterpret the period as a mistake.
2021-07-10 12:43:10 +10:00
Jonathan Rubenstein
e96a80dd20 [doc] faq: Correct log file tray operation 2021-07-07 23:19:54 +10:00
Jonathan Rubenstein
c626385845 [doc] index: Nuke trello and add ethereum address 2021-07-07 23:19:54 +10:00
Jonathan Rubenstein
dacd0ab844 [doc] faq/install: Move Clipboard Synch instructions to Installation 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
8c43972786 [doc] faq: Touchup 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
acac8b40cb [doc] module: Touchups 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
6f5e5aa0c2 [doc] obs: Touchup 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
13e9488667 [doc] install/troubleshooting: AppArmor instructions already in Installation 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
13e76e6db2 [doc] troubleshooting: B4 touchup 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
e2c3ffcbb4 [doc] host: Touchups and sentence flow corrections 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
733e634f4d [doc] install: Touch ups and tweaks 2021-07-06 07:27:16 +10:00
Jonathan Rubenstein
86c7cfe589 [doc] Rerganize content into install and build pages 2021-05-25 19:52:08 +10:00
Jonathan Rubenstein
6da04655f0 [doc] troubleshooting: Move link to new website 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
b7765a22df [doc] index: IRC moved 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
397af46909 [doc] index: Correct spelling and add irc, trello, and donate info 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
8920d01dab [doc] module: Change AppArmor path for libvirt to include local/ 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
00c15238e8 [doc] host: Better formatting for Windows on Windows 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
75d48de905 [doc] host: Reformat build instructions for all platforms 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
94ffcfba23 [doc] install: Add warning about downloading with git 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
5f20a026b2 [doc] install: Rename Running the Client to Usage
Also move relevant sentence into Usage
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
b64fa56b26 [doc] module: Add instructions for systemd-modules-load.d 2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
5fb6c73263 [doc] host: Imported from host/README.md
Placed at bottom of Technical FAQ to hide it
host/README.md removed
2021-05-25 16:57:52 +10:00
Jonathan Rubenstein
77a4c114e9 [doc] module: Import from module/README.md 2021-05-25 16:57:52 +10:00