[tor-commits] [orbot/master] Build instructions clarification + markdown

[n8fr8 at torproject.org]

commit 975053b7bb7bf6a84dc97635d721eba7b5c27794
Author: bim <dsnake at protonmail.com>
Date:   Wed Aug 26 23:32:52 2020 -0400

    Build instructions clarification + markdown
---
 BUILD => BUILD.md | 24 ++++++++++--------------
 1 file changed, 10 insertions(+), 14 deletions(-)

diff --git a/BUILD b/BUILD.md
similarity index 68%
rename from BUILD
rename to BUILD.md
index 1b056861..b1e9a362 100644
--- a/BUILD
+++ b/BUILD.md
@@ -2,15 +2,14 @@ This document explains how to properly build an Android package of Orbot from
 source.
 
 Orbot includes, in the external directory, git repo submodules of:
-	- JTorControl: The Tor Control Library for Java
-	- BadVPN
-	- JSocks
+- JTorControl: The Tor Control Library for Java
+- BadVPN
+- JSocks
 
 Please install the following prerequisites (instructions for each follows):
-	Android Native Dev Kit or NDK (for C/C++ code):
-        http://developer.android.com/sdk/ndk/index.html
-	Android Software Dev Kit or SDK (for Java code):
-        http://developer.android.com/sdk/index.html
+	
+- Android Software Development Kit or SDK (for Java code): http://developer.android.com/sdk/index.html *(Android Studio)*
+- Android Native Development Kit or NDK (for C/C++ code) http://developer.android.com/sdk/ndk/index.html *(This can be installed through Android Studio's SDK Manager)*
 
 Be sure that you have all of the git submodules up-to-date:
 
@@ -19,7 +18,7 @@ Be sure that you have all of the git submodules up-to-date:
 
 You then need to run "ndk-build" and the following commands to compile and prepare Orbot's native code:
 
-	UNIX:	
+UNIX:	
 		
 		cd orbotservice/src/main
 		ndk-build (located in Android/Sdk/ndk/VERSION/)
@@ -28,7 +27,7 @@ You then need to run "ndk-build" and the following commands to compile and prepa
 		mv libs/x86/pdnsd libs/x86/pdnsd.so
 		mv libs/x86_64/pdnsd libs/x86_64/pdnsd.so
 
-	Windows:
+Windows:
 
 		cd orbotservice\src\main
 		ndk-build.cmd (located in Android\Sdk\ndk\VERSION\) 
@@ -42,9 +41,6 @@ Now build the Android app using Android Studio/gradle
 
 This will produce an unsigned Orbot package APK.
 
-To produce a usable package, you'll need to sign the .apk. The basics on
-signing can be found on the Android developer site:
-
-	http://developer.android.com/guide/publishing/app-signing.html
-
+To produce a usable package, you'll need to sign the .apk. The basics on signing can be found on the Android developer site:
 
+http://developer.android.com/guide/publishing/app-signing.html
\ No newline at end of file