Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2024-11-25 14:57:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[c-host] better formatting of README.md

Browse Source
This commit is contained in:
Geoffrey McRae 2019-04-10 22:08:14 +10:00
parent da7c66419a
commit 878eb057d1
2 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
VERSION
View File

@ -1 +1 @@
a12-147-gd5ad53dae7+1 a12-148-gda7c66419a+1

28
c-host/README.md
View File

@ -1,8 +1,10 @@
# What is this? # General Questions
## What is this?
This is an experimental rewrite of the host application in pure C using the MinGW toolchain. This is an experimental rewrite of the host application in pure C using the MinGW toolchain.
# Why make this? ## Why make this?
Several reasons: Several reasons:
@ -11,24 +13,24 @@ Several reasons:
3. The host is a jumbled mess of code from all the experimentation going on 3. The host is a jumbled mess of code from all the experimentation going on
4. I would eventually like to be able to port this to run on Linux guests 4. I would eventually like to be able to port this to run on Linux guests
# Why C and not C++ (or some other language) ## Why C and not C++ (or some other language)
Beacuse I like C and for this project believe that C++ is overkill Beacuse I like C and for this project believe that C++ is overkill
# When will it be ready? ## When will it be ready?
No idea No idea
# Will it replace the C++ host? ## Will it replace the C++ host?
Yes, but only when it is feature complete. Yes, but only when it is feature complete.
# Why doesn't this use CMake? ## Why doesn't this use CMake?
It does now... It does now...
~~Because win-builds doesn't distribute it, so to make it easy for everyone to compile we do not require it.~~ ~~Because win-builds doesn't distribute it, so to make it easy for everyone to compile we do not require it.~~
# How do I build it? ## How do I build it?
Don't ask if you can't figure it out, this code is the very definition of experiemental and incomplete and should not be in use yet. Don't ask if you can't figure it out, this code is the very definition of experiemental and incomplete and should not be in use yet.
@ -41,7 +43,7 @@ cmake -G "MSYS Makefiles" ..
make make
``` ```
# Where is the log? ## Where is the log?
It is in your user's temp directory: It is in your user's temp directory:
@ -51,7 +53,7 @@ For example:
C:\Users\YourUser\AppData\Local\Temp\looking-glass-host.txt C:\Users\YourUser\AppData\Local\Temp\looking-glass-host.txt
# Why does this version require Administrator privileges ## Why does this version require Administrator privileges
This is intentional for several reasons. This is intentional for several reasons.
@ -59,15 +61,17 @@ This is intentional for several reasons.
2. NvFBC requires administrator level access to enable the interface in the first place. (WIP) 2. NvFBC requires administrator level access to enable the interface in the first place. (WIP)
3. DXGI performance can be improved if we have this. (WIP) 3. DXGI performance can be improved if we have this. (WIP)
# Why isn't there a build with NvFBC support available. # NvFBC (NVIDIA Frame Buffer Capture)
## Why isn't there a build with NvFBC support available.
Because NVIDIA have decided to put restrictions on the NvFBC API that simply make it incompatible with the GPL/2 licence. Providing a pre-built binary with NvFBC support would violate the EULA I have agreed to in order to access the NVidia Capture SDK. Because NVIDIA have decided to put restrictions on the NvFBC API that simply make it incompatible with the GPL/2 licence. Providing a pre-built binary with NvFBC support would violate the EULA I have agreed to in order to access the NVidia Capture SDK.
# Why can't I compile NvFBC support into the host ## Why can't I compile NvFBC support into the host
You must download and install the NVidia Capture SDK. Please note that by doing so you will be agreeing to NVIDIA's SDK License agreement and the binary you produce can not be distributed. You must download and install the NVidia Capture SDK. Please note that by doing so you will be agreeing to NVIDIA's SDK License agreement and the binary you produce can not be distributed.
# Can't you just re-write the NvFBC headers? ## Can't you just re-write the NvFBC headers?
Technically yes, but since I have already agreed to the SDK License Agreement and seen the headers, I am tainted. Technically yes, but since I have already agreed to the SDK License Agreement and seen the headers, I am tainted.