Browse Source

fix(docs): Correction of typos in project documentation (#5206)

master
Jeffrey 1 year ago
committed by GitHub
parent
commit
59dbb37c9a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      COMPILING.md
  2. 2
      TESTING.md

2
COMPILING.md

@ -178,7 +178,7 @@ When running the compile script, make sure to have the necessary build tools ins
NDK="path/to/ndk/root" CMAKE="path/to/cmake/executable" android/compile.sh <abi|all|clean>
```
The NDK variable must be set to the path to the NDK root, CMAKE to a call of the cmake binary used for compiling. If the cmake binary is in the PATH, a simple `CMAKE=cmake` is enough. As last parameter you either have to enter a correct ABI (see https://cmake.org/cmake/help/latest/variable/CMAKE_ANDROID_ARCH_ABI.html) or either all or clean. Clean will cause the script to remove the android-build directory, all will compile and zip all Cuberite for all 7 ABIs and create a zip archive of the android/Server direcory for use in the official Android app. If you are unsure which ABI is required for your phone, open the official Android app and navigate to "Settings" and "Install". It will show you the required ABI. Additional parameters may be given through enviroment variables, namely TYPE="" as Release or Debug (defaults to Release) and THREADS="4" as the number of threads used for compilation (defaults to 4).
The NDK variable must be set to the path to the NDK root, CMAKE to a call of the cmake binary used for compiling. If the cmake binary is in the PATH, a simple `CMAKE=cmake` is enough. As last parameter you either have to enter a correct ABI (see https://cmake.org/cmake/help/latest/variable/CMAKE_ANDROID_ARCH_ABI.html) or either all or clean. Clean will cause the script to remove the android-build directory, all will compile and zip all Cuberite for all 7 ABIs and create a zip archive of the android/Server direcory for use in the official Android app. If you are unsure which ABI is required for your phone, open the official Android app and navigate to "Settings" and "Install". It will show you the required ABI. Additional parameters may be given through environment variables, namely TYPE="" as Release or Debug (defaults to Release) and THREADS="4" as the number of threads used for compilation (defaults to 4).
### Running the Executables on a Device

2
TESTING.md

@ -14,7 +14,7 @@ Please use the issue tracker search feature and make sure your issue has not bee
Obtaining Debug Builds
----------------------
When testing Cuberite, debug builds are preferred because they output detailed info about the problem that had occured at the server console.
When testing Cuberite, debug builds are preferred because they output detailed info about the problem that had occurred at the server console.
Currently, we do not provide debug builds. You will have to compile Cuberite yourself to obtain them. See the compilation instructions.
You can also test with regular builds.

Loading…
Cancel
Save