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
