From 994ec732a4d7192d6af37cf61c2660afa413c927 Mon Sep 17 00:00:00 2001 From: Janith Udayanga Date: Wed, 23 Oct 2019 10:48:48 +0530 Subject: [PATCH 1/2] Update QUICKSTART.md Corrected Typos, Added Links to the mentioned Repos, Made Topics more clear & more readable. --- QUICKSTART.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 23a826fd..d31dbad3 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -1,17 +1,17 @@ -### Introduction +# Introduction If you would like to contribute to the Android app, but find the build documentation a little daunting, this guide lets you copy-paste your way to a successful APK build. -#### Estimated build time +### Estimated build time 25 - 40 minutes (depending on Internet connection speeds) -#### What do you need? -* A computer running Ubuntu 18.04 +### What do you need? +* A computer running [Ubuntu 18.04](https://ubuntu.com/download/desktop) * Internet access to download modules and packages. * At least 15GB of free disk space. -* Alternatively, Docker. You can skip steps 1 through 5 if you make use of the `lbry/android-base` Docker base image. Scroll down to Fast track if you would prefer to use Docker. +* Alternatively, Docker. You can skip steps 1 through 5 if you make use of the `lbry/android-base` Docker base image. Scroll down to [Fast Track](#Fast-Track) at the bottom of the page if you would prefer to use Docker. ### Step 1 of 10 -Install all the apt packages required by running the following commands. You can copy-paste directly to your terminal. +Install all the apt packages required by running the following commands. You can copy-paste this directly to your terminal. ``` sudo dpkg --add-architecture i386 sudo apt-get -y update @@ -32,7 +32,7 @@ sudo -H pip install --upgrade cython==0.28.1 setuptools ``` ### Step 3 of 10 -Install buildozer, a tool for creating the apk package using the python for android toolchain. +Install [buildozer](https://github.com/lbryio/buildozer.git), a tool for creating the apk package using the python for android toolchain. ``` git clone https://github.com/lbryio/buildozer.git cd buildozer && python2.7 setup.py install && cd .. @@ -72,7 +72,7 @@ wget 'https://www.crystax.net/download/crystax-ndk-10.3.2-linux-x86_64.tar.xz' - ``` ### Step 7 of 10 -Clone the lbryio/lbry-android git repository, initialise submodules and create your `buildozer.spec` and `google-services.json` files. The provided `buildozer.spec.sample` contains defaults provided you followed steps 1 through 5 exactly as described. You can also customise the spec file if you want to. The `google-services.sample.json` can be used to ensure the build completes successfully. +Clone the [lbryio/lbry-android git repository](https://github.com/lbryio/lbry-android), initialise submodules and create your `buildozer.spec` and `google-services.json` files. The provided `buildozer.spec.sample` contains defaults provided you followed steps 1 through 5 exactly as described. You can also customise the spec file if you want to. The `google-services.sample.json` can be used to ensure the build completes successfully. ``` git clone https://github.com/lbryio/lbry-android cd lbry-android @@ -110,4 +110,4 @@ sudo apt-get install docker-ce docker run -it lbry/android-base:latest /bin/bash ``` -**Protip:** You can also make use of Docker to run your builds on macOS or Windows. +**Pro Tip:** You can also make use of Docker to run your builds on macOS or Windows. From 9a5d63b7fcb7834b5545a13c7aed7f1460fd37ab Mon Sep 17 00:00:00 2001 From: Thomas Zarebczan Date: Mon, 28 Oct 2019 10:27:48 -0400 Subject: [PATCH 2/2] Update QUICKSTART.md --- QUICKSTART.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index d31dbad3..4594fc66 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -103,7 +103,7 @@ If you made it this far, you're finally ready to build the package! You just hav buildozer android debug ``` -### Fast Track +### Fast Track {#Fast-Track} Install Docker and start a container using the `lbry/android-base` image, which is about 1.72GB in size. Run the following commands for Ubuntu and then follow steps 6 through 10 in the container's bash prompt. ``` sudo apt-get install docker-ce