diff options
| -rw-r--r-- | docs/README.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/README.md b/docs/README.md index c192e6e4..af5fece2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,20 +1,20 @@ -# box64 -  + Linux Userspace x86_64 Emulator with a twist ----- - +[View changelog](https://github.com/ptitSeb/box64/blob/main/docs/CHANGELOG.md) | [中文](https://github.com/ptitSeb/box64/blob/main/docs/README_CN.md) | [Report an error](https://github.com/ptitSeb/box64/issues/new) -[中文](README_CN.md) +      + +---- Box64 lets you run x86_64 Linux programs (such as games) on non-x86_64 Linux systems, like ARM (host system needs to be 64-bit little-endian). -You can find many more Box64 video on YouTube in the [MicroLinux](https://www.youtube.com/channel/UCwFQAEj1lp3out4n7BeBatQ), [Pi Labs](https://www.youtube.com/channel/UCgfQjdc5RceRlTGfuthBs7g) or [The Byteman](https://www.youtube.com/channel/UCEr8lpIJ3B5Ctc5BvcOHSnA) channels. +You can find many Box64 videos on the [MicroLinux](https://www.youtube.com/channel/UCwFQAEj1lp3out4n7BeBatQ), [Pi Labs](https://www.youtube.com/channel/UCgfQjdc5RceRlTGfuthBs7g) or [The Byteman](https://www.youtube.com/channel/UCEr8lpIJ3B5Ctc5BvcOHSnA) YouTube channels. -Because Box64 uses the native versions of some "system" libraries, like libc, libm, SDL, and OpenGL, it's easy to integrate and use with most applications, and performance can be surprisingly high in many cases. Take a look at thoses bench analysis for an example [here](https://box86.org/index.php/2021/06/game-performances/). +Since Box64 uses the native versions of some "system" libraries, like libc, libm, SDL, and OpenGL, it's easy to integrate and use with most applications, and performance can be surprisingly high in many cases. Take a look at thoses bench analysis for an example [here](https://box86.org/index.php/2021/06/game-performances/). -Box64 integrates a DynaRec (dynamic recompiler) for the ARM64 platform, providing a speed boost between 5 to 10 times faster than using only the interpreter. Some high level information on how the DynaRec works can be found [here](https://box86.org/2021/07/inner-workings-a-high%e2%80%91level-view-of-box86-and-a-low%e2%80%91level-view-of-the-dynarec/). +Box64 integrates with DynaRec (dynamic recompiler) for the ARM64 platform, providing a speed boost between 5 to 10 times faster than using only the interpreter. Some high level information on how DynaRec works can be found [here](https://box86.org/2021/07/inner-workings-a-high%e2%80%91level-view-of-box86-and-a-low%e2%80%91level-view-of-the-dynarec/). Some x64 internal opcodes use parts of "Realmode X86 Emulator Library", see [x64primop.c](../src/emu/x64primop.c) for copyright details @@ -29,7 +29,7 @@ Usage There are a few environment variables to control the behaviour of Box64. -See [here](USAGE.md) all the environment variables and what they do. +See [here](USAGE.md) for all the environment variables and what they do. Note: Box64's Dynarec uses a mechanism with Memory Protection and a SegFault signal handler to handle JIT code. In simpler terms, if you want to use GDB to debug a running program that use JIT'd code (like mono/Unity3D), you will still have many "normal" segfaults triggering. It is suggested to use something like `handle SIGSEGV nostop` in GDB to not stop at each segfault, and maybe put a breakpoint inside `my_memprotectionhandler` in `signals.c` if you want to trap SegFaults. @@ -37,14 +37,14 @@ Note: Box64's Dynarec uses a mechanism with Memory Protection and a SegFault sig Compiling/Installation ---- -> Compilation instructions can be found [here](COMPILE.md) +> Compilation instructions can be found [here](COMPILE.md). ---- Version history/Change log ---- -The change log is available [here](CHANGELOG.md) +The change log is available [here](CHANGELOG.md). ---- @@ -62,8 +62,8 @@ Notes about Unity game emulation ---- Running Unity games is a hit or miss for now. Unity uses Mono (which uses signals that are not always emulated in a 100% accurate way). -You should also note that some Unity3D games require OpenGL 3+ which can be tricky to provide on ARM SBC (single-board computers) for now. -So, not all Unity games work and can require a high OpenGL profile, but many actualy works now +You should also note that some Unity3D games require OpenGL 3+ which can be tricky to provide on ARM SBC (single-board computers). +So, not all Unity games work and can require a high OpenGL profile, but many actualy work now. Hint: on Pi4, use `MESA_GL_VERSION_OVERRIDE=3.2` and with Panfrost use `PAN_MESA_DEBUG=gl3` to use higher profile if the game starts then quits before showing anything. ---- @@ -93,14 +93,14 @@ Wine64 is supported on box64. Be aware that 64-bit Wine also includes 32-bit com Notes about Vulkan ---- -Box64 wrap Vulkan libraries. But note that it as only been tested with a RX550 card, some extensions may be missing depending on your graphic card. +Box64 wraps Vulkan libraries, but note that it as only been tested with a RX550 card, some extensions may be missing depending on your graphics card. ---- Final word ---- -I want to thank everyone who has contributed to box64 developpement. +I want to thank everyone who has contributed to box64 development. There are many ways to contribute: code contribution, financial, hardware and advertisement! So, in no particular order, I want to thank: * For their major code contribution: rajdakin, mogery |