From 3b2797f1e1b0d5bb95c41942ae558e01fd7d3b6b Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 13:12:12 -0500 Subject: Improve README --- docs/README.md | 41 ++++++++++++++++++++++++++++------------- 1 file changed, 28 insertions(+), 13 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index c192e6e4..6ff66f03 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,20 +1,35 @@ # box64 ![Official logo](img/Box64Logo.png "Official Logo") -Linux Userspace x86_64 Emulator with a twist ----- -![box64 build status](https://app.travis-ci.com/ptitSeb/box64.svg?branch=main) +

Linux Userspace x86_64 Emulator with a twist +

+ + View changelog + | + + 中文 + | + + Report an error + +

+ build status + stars + forks + contributors + prs + issues -[中文](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 @@ -37,14 +52,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 +77,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 +108,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 -- cgit 1.4.1 From d09358575094d590e75d67a4da3e217f4d18a866 Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 13:13:17 -0500 Subject: Update README.md --- docs/README.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index 6ff66f03..fb5ff01c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,3 @@ -# box64 - ![Official logo](img/Box64Logo.png "Official Logo")

Linux Userspace x86_64 Emulator with a twist -- cgit 1.4.1 From b7f16075cab4cd70596458e128c7bc8ad38951f4 Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 13:14:05 -0500 Subject: Update README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index fb5ff01c..c3a8860f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -42,7 +42,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. -- cgit 1.4.1 From 262d5670fece48371542bb2f972332fb3b26e34c Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 14:15:17 -0500 Subject: Update README.md --- docs/README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index c3a8860f..23834748 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,14 +2,9 @@

Linux Userspace x86_64 Emulator with a twist

- - View changelog - | - - 中文 - | - - Report an error + [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)

build status -- cgit 1.4.1 From 96b27013f8c7f3fdf4f4dbab84ec88ceeb6e140e Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 14:17:24 -0500 Subject: Update README.md --- docs/README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index 23834748..c3a8860f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,9 +2,14 @@

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) + + View changelog + | + + 中文 + | + + Report an error

build status -- cgit 1.4.1 From 9d7652d3ba383ffbbebd92c212792e9dfee072a8 Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 18:33:18 -0500 Subject: Update readme.md --- docs/README.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index c3a8860f..af31ae0b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,8 @@ ![Official logo](img/Box64Logo.png "Official Logo") -

Linux Userspace x86_64 Emulator with a twist -

- - View changelog - | - - 中文 - | - - Report an error +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)

build status -- cgit 1.4.1 From 3d36eb6345a9b3395c12fcbb27c0eebb7d2b322f Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 18:38:43 -0500 Subject: Update readme.md --- docs/README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index af31ae0b..bbd43b94 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,15 +2,9 @@ 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) - -

- build status - stars - forks - contributors - prs - issues +[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) + +![build](https://app.travis-ci.com/ptitSeb/box64.svg?branch=main) ![stars](https://img.shields.io/github/stars/ptitSeb/box64) ![forks](https://img.shields.io/github/forks/ptitSeb/box64) ![contributors](https://img.shields.io/github/contributors/ptitSeb/box64) [prs](https://img.shields.io/github/issues-pr/ptitSeb/box64) [issues](https://img.shields.io/github/issues/ptitSeb/box64) ---- -- cgit 1.4.1 From 2cad9392c4a3bfe4cb86ee16421abdafc934726c Mon Sep 17 00:00:00 2001 From: Ryan Fortner <71036629+ryanfortner@users.noreply.github.com> Date: Mon, 22 Nov 2021 18:39:03 -0500 Subject: Update readme.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index bbd43b94..af5fece2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ 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) -![build](https://app.travis-ci.com/ptitSeb/box64.svg?branch=main) ![stars](https://img.shields.io/github/stars/ptitSeb/box64) ![forks](https://img.shields.io/github/forks/ptitSeb/box64) ![contributors](https://img.shields.io/github/contributors/ptitSeb/box64) [prs](https://img.shields.io/github/issues-pr/ptitSeb/box64) [issues](https://img.shields.io/github/issues/ptitSeb/box64) +![build](https://app.travis-ci.com/ptitSeb/box64.svg?branch=main) ![stars](https://img.shields.io/github/stars/ptitSeb/box64) ![forks](https://img.shields.io/github/forks/ptitSeb/box64) ![contributors](https://img.shields.io/github/contributors/ptitSeb/box64) ![prs](https://img.shields.io/github/issues-pr/ptitSeb/box64) ![issues](https://img.shields.io/github/issues/ptitSeb/box64) ---- -- cgit 1.4.1