Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2024-11-28 08:17:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
3,342 Commits 15 Branches 37 Tags 7.8 MiB
ed512f5943
Commit Graph

165 Commits

Author SHA1 Message Date
Geoffrey McRae
ed512f5943 [doc] fix typos 2024-03-08 18:32:38 +11:00
Geoffrey McRae
4a4f72ba38 [doc] update and restructure installation documentation 2024-03-08 18:22:07 +11:00
Jonathan Rubenstein
62aef5a240 [doc] build: Move NvFBC note into don't build warning 
Also:
   - Add link to warning (#dont-build-the-host)
 2023-11-11 10:32:15 +11:00
Jonathan Rubenstein
4f508d320a [doc] words: Sort using sort_words.py 2023-11-11 10:31:51 +11:00
Jonathan Rubenstein
29f1434270 [doc] sort_words: Create sort_words.py to make words.txt easier to maintain 
sort_words.py outputs a diff that if applied will sort words.txt

It has a few options:
    - '--add-word': Add a word before sorting (usable multiple times)
    - '--save': Save changes to file instead of only outputting a diff
    - '--quiet': Don't output a diff
 2023-11-11 10:31:51 +11:00
Jonathan Rubenstein
f6b2cec841 [doc] html_unescape: Create html.unescape extension 
This new sphinx extension runs html.unescape
(from the Python Standard Library) on source files before they are
rendered, allowing escape sequences like  ' ' for the no-break
space character.

I have also published this extension in my own name under a different
license (the same one Sphinx uses) for others to use:
https://github.com/JJRcop/sphinxcontrib-html_unescape
 2023-11-02 06:21:51 +11:00
Jonathan Rubenstein
626f5eb32e [doc] usage: Actually add non-breaking spaces to config file 
In 3625207801 I attempted to add
non-breaking spaces to a filepath so it would stay on one line.
Before this I had accidentally deleted my work but found it saved
in my sphinx build cache, so I copied my changes from that cache.

Unfortunately the cached version replaced non-breaking spaces with
real spaces and 3625207801 was made
reverted.

This commit re-adds the non-breaking spaces.
 2023-11-02 06:21:51 +11:00
Jonathan Rubenstein
29c797d7b6 [doc] usage: Add Selecting an IVSHMEM device 2023-10-30 14:16:28 +11:00
Jonathan Rubenstein
3625207801 [doc] usage: Add non-breaking spaces to config path 2023-10-30 14:16:28 +11:00
Jonathan Rubenstein
25d6dd3ba2 [doc] usage: Refresh opening paragraph in Host usage 2023-10-30 14:16:28 +11:00
Geoffrey McRae
1cf8e8c846 [doc] add luminance to words 2023-10-20 15:34:35 +11:00
Geoffrey McRae
8d90c9c2a5 [doc] add new words to words.txt 2023-09-12 01:27:34 +10:00
Jonathan Rubenstein
219c73edbe [doc] faq.rst: Reword libdecor package installation 
Also change package name to Debian
package libdecor-0-dev
 2023-07-25 10:15:28 +10:00
Jonathan Rubenstein
6522920ea1 [doc] faq.rst: Update libdecor source link 
Source code moved from https://gitlab.gnome.org/jadahl/libdecor
to https://gitlab.freedesktop.org/libdecor/libdecor
 2023-07-25 10:15:28 +10:00
Jonathan Rubenstein
4f09d5b771 [doc] troubleshooting: Rewrite missing desktop 2023-04-04 23:31:41 +10:00
Geoffrey McRae
e067db7bb4 [doc] fix typos and correct 1440p resolution. 
Closes #1064
Closes #1061
 2023-03-19 12:57:16 +11:00
Geoffrey McRae
2ba23e8646 [doc] install: fix forumla again 2022-09-20 07:13:27 +10:00
Geoffrey McRae
5fd9bc6a84 [doc] install: remove syntax highliting from ivshmem formula 2022-09-19 22:18:25 +10:00
Geoffrey McRae
7446fe8c99 [doc] install: cleanup ivshmem forumla formatting 2022-09-19 22:15:40 +10:00
Geoffrey McRae
136410daac [doc] install: be a bit clearer about calculating the ivshmem size 2022-09-19 22:11:17 +10:00
Quantum
b6f994b511 [doc] css: add custom style for <kbd> elements 
This makes them look like actual keys.
 2022-09-19 14:59:40 +10:00
Quantum
9b0af43a42 [doc] usage: improve ini syntax documentation 
This uses syntax highlighting for the config file and also documents
the ; comment character.
 2022-09-19 14:59:19 +10:00
Quantum
0f1eb0fa7f [doc] usage: fix command name bolding 
Note that **``looking-glass-client``** is not valid syntax.
 2022-09-19 14:59:01 +10:00
Tudor Brindus
6a9075b412 [doc]: a bunch of consistency fixes 2022-09-19 11:14:09 +10:00
Tudor Brindus
6d19e85fa4 [doc]: use arrow characters 2022-09-19 10:30:08 +10:00
Tudor Brindus
2780f6c22f [doc]: make title casing consistent 2022-09-19 10:30:08 +10:00
Tudor Brindus
33bcf19164 [doc]: usage.rst: update supported configuration options 2022-09-19 10:30:08 +10:00
Tudor Brindus
86793a657e [doc]: usage.rst:: add new keybindings 2022-09-19 10:30:08 +10:00
Geoffrey McRae
0ee45d8a70 [doc] add common ivshmem sizes and additional warnings/notes 2022-09-19 09:59:26 +10:00
Geoffrey McRae
3b16fb1baa [doc] fix typo 2022-09-18 20:43:29 +10:00
Geoffrey McRae
57c2e47cbf [doc] add comment to state that NvFBC reads NVFBC_PRIV_DATA if set 2022-09-18 20:42:46 +10:00
Geoffrey McRae
a5e6065d39 [doc] added host usage documentation for DXGI and NvFBC 2022-09-18 20:27:03 +10:00
Geoffrey McRae
b10d912ab6 [doc] update copyright year 2022-09-18 19:28:19 +10:00
Geoffrey McRae
9a26519e9b [doc] added spencercw to the words list 2022-09-18 18:54:55 +10:00
Geoffrey McRae
5a02e600c3 [doc] added spencercw to the LG docs credits 2022-09-18 18:54:08 +10:00
Geoffrey McRae
def838b883 [doc] update FAQ regarding Audio support 2022-09-18 14:33:17 +10:00
Geoffrey McRae
7e032f67be [doc] reorder and update installation section 2022-09-18 14:17:17 +10:00
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