[tor-commits] [tor-browser/tor-browser-52.7.2esr-8.0-1] Orfox: Fix #1 - Improve build instructions

[gk at torproject.org]

commit 03f65d64913229abf74b964da309535db3919679
Author: Amogh Pradeep <amoghbl1 at gmail.com>
Date:   Tue Jul 14 00:52:24 2015 -0400

    Orfox: Fix #1 - Improve build instructions
    
    Signed-off-by: Amogh Pradeep <amoghbl1 at gmail.com>
---
 README.md  | 20 ++++++++++++++++++++
 README.txt | 27 ---------------------------
 2 files changed, 20 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..8cf5ca26625a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+## ORFOX BUILD STEPS:
+
+1) Move .mozconfig-android to .mozconfig OR run: 
+```
+export MOZCONFIG="tor-browser/.mozconfig-android"
+```
+2) Checks if the all requirements for the build are fine with:
+```    
+./mach configure
+```
+3) Builds the repo with:
+```
+./mach build
+```
+4) Creates the apk in tor-browser/MOZ_OBJDIR/dist/fennec-38.0.en-US.android-arm.apk
+```
+./mach package
+```
+### Note: this does not ship the addons, that is managed in a different repo: https://github.com/amoghbl1/orfox-addons.
+### Steps to include these addons can be figured out looking at the jenkins script at https://github.com/amoghbl1/Orfox/blob/master/jenkins-build
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 658c0dce3174..000000000000
--- a/README.txt
+++ /dev/null
@@ -1,27 +0,0 @@
-An explanation of the Mozilla Source Code Directory Structure and links to
-project pages with documentation can be found at:
-
-    https://developer.mozilla.org/en/Mozilla_Source_Code_Directory_Structure
-
-For information on how to build Mozilla from the source code, see:
-
-    http://developer.mozilla.org/en/docs/Build_Documentation
-
-To have your bug fix / feature added to Mozilla, you should create a patch and
-submit it to Bugzilla (https://bugzilla.mozilla.org). Instructions are at:
-
-    http://developer.mozilla.org/en/docs/Creating_a_patch
-    http://developer.mozilla.org/en/docs/Getting_your_patch_in_the_tree
-
-If you have a question about developing Mozilla, and can't find the solution
-on http://developer.mozilla.org, you can try asking your question in a
-mozilla.* Usenet group, or on IRC at irc.mozilla.org. [The Mozilla news groups
-are accessible on Google Groups, or news.mozilla.org with a NNTP reader.]
-
-You can download nightly development builds from the Mozilla FTP server.
-Keep in mind that nightly builds, which are used by Mozilla developers for
-testing, may be buggy. Firefox nightlies, for example, can be found at:
-
-    https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central/
-            - or -
-    http://nightly.mozilla.org/