diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/COMPILE.md | 45 |
1 files changed, 24 insertions, 21 deletions
diff --git a/docs/COMPILE.md b/docs/COMPILE.md index 175ad170..756562de 100755 --- a/docs/COMPILE.md +++ b/docs/COMPILE.md @@ -2,7 +2,7 @@ Compiling ---- #### for RK3399 -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 cd box64 @@ -17,7 +17,7 @@ sudo systemctl restart systemd-binfmt #### for PI4 -Warning, you need a 64bits OS: +Warning, you need a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 @@ -33,7 +33,7 @@ sudo systemctl restart systemd-binfmt #### for TEGRA X1 -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 @@ -49,7 +49,7 @@ sudo systemctl restart systemd-binfmt #### for Snapdragon 845 -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 @@ -67,7 +67,7 @@ sudo systemctl restart systemd-binfmt ---- #### for Phytium -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 cd box64 @@ -103,7 +103,7 @@ sudo systemctl restart systemd-binfmt #### for LoongArch -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 @@ -119,7 +119,7 @@ sudo systemctl restart systemd-binfmt #### for RISCV -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 @@ -135,7 +135,7 @@ sudo systemctl restart systemd-binfmt #### for PowerPC 64 LE -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 @@ -151,7 +151,7 @@ sudo systemctl restart systemd-binfmt #### for LX2160A -Using a 64bits OS: +Using a 64bit OS: ``` git clone https://github.com/ptitSeb/box64 @@ -169,7 +169,7 @@ sudo systemctl restart systemd-binfmt `mkdir build; cd build; cmake .. -DLD80BITS=1 -DNOALIGN=1 -DCMAKE_BUILD_TYPE=RelWithDebInfo; make -j$(nproc)` -If you encounter some linking errors, try activating `NOLOADADDR` (`cmake -DNOLOADADDR=ON; make -j$(nproc)`). +If you encounter some linking errors, try using `NOLOADADDR=ON` (`cmake -DNOLOADADDR=ON; make -j$(nproc)`). ### use ccmake @@ -177,33 +177,36 @@ Alternatively, you can **use the curses-bases ccmake (or any other gui frontend ### Customize your build -*Use ccache if you have it* +#### Use ccache if you have it Add `-DUSE_CCACHE=1` if you have ccache (it's better if you plan to touch the sources) -*To have some debug info* +#### To have some debug info The `-DCMAKE_BUILD_TYPE=RelWithDebInfo` argument makes a build that is both optimized for speed, and has debug information embedded. That way, if you have a crash or try to analyse performance, you'll have some symbols. -*To have a Trace Enabled build* +#### To have a Trace Enabled build -To have a trace enabled build ( ***the interpretor will be slightly slower***), add `-DHAVE_TRACE=1` but you will need, at runtime, to have the [Zydis library](https://github.com/zyantific/zydis) library in your `LD_LIBRARY_PATH` or in the system library folders. +To have a trace enabled build (***the interpreter will be slightly slower***), add `-DHAVE_TRACE=1`. But you will need to have the [Zydis library](https://github.com/zyantific/zydis) in your `LD_LIBRARY_PATH` or in the system library folders at runtime. -*To have ARM Dynarec* +#### To have ARM Dynarec -The Dynarec is only available on the ARM architecture(Right now, anyways.). Notes also that VFPv3 and NEON are required for the Dynarec. Activate it by using `-DARM_DYNAREC=1`. +Dynarec is only available on ARM (for the meantime), Activate it by using `-DARM_DYNAREC=1`. +###### *Note: VFPv3 and NEON are required for Dynarec.* -*Not building from a git clone* +#### Not building from a git clone -If you are not building from a git clone (for example, downloading a release source zipped from github), you need to activate `-DNOGIT=1` from cmake to be able to build (normal process include git sha1 of HEAD in the version that box64 print). +If you are not building from a git clone (for example, downloading a release source code zip from github), you need to use `-DNOGIT=1` from cmake to be able to build (box64 uses git SHA1 to show last commit in version number). ---- Testing ---- -A few tests are included. -They can be launched with `ctest` -They are very basic and don't test much for now. +A few tests are included with box64. + +They can be launched using the `ctest` command. + +The tests are very basic and only tests some functionality for now. ---- |