Skip to content
This repository has been archived by the owner on Nov 9, 2018. It is now read-only.

Cleanup Markdown formatting to render in GFM #878

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Brave for Android (formerly Link Bubble)

##Install instructions and setup
## Install instructions and setup

`git clone [email protected]:brave/browser-android.git`
git clone [email protected]:brave/browser-android.git

Either install the [Crashlytics/Fabric Android Studio plugin](http://try.crashlytics.com/sdk-android/) or copy `Application/LinkBubble/fabric.properties.template` to `Application/LinkBubble/fabric.properties` and fill in the apiSecret.

Expand All @@ -11,13 +11,13 @@ Copy `Application/LinkBubble/src/main/java/com/linkbubble/ConfigAPIs.java.templa
Copy `Application/LinkBubble/src/main/AndroidManifest.xml.template` to `Application/LinkBubble/src/main/AndroidManifest.xml` and fill in `com.crashlytics.ApiKey` and
`io.fabric.ApiKey` with your Crashlytics API key. You can obtain it from logging into your Fabric account and going to: `Settings -> Organizations -> Brave (or your organization)` then click on `API Key` at the top.

npm install
npm install

##Building
## Building

Open `./Application/` in Android Studio and build. You'll need the NDK installed if you don't already have it, instructions below.

##Building release build
## Building release build

Copy `build-release.sh.template` to `build-release.sh`.

Expand All @@ -29,34 +29,37 @@ If you get an error about similar to:

Try uninstalling the application which already exists on your plugged in device.

##Installing the NDK
## Installing the NDK

Android Studio has an easy way to download and link to the NDK.

In the menu navigate to File, Project Structure. Click the 'Download Android NDK' link. This should download and unzip the NDK, as well as link it inside of local.properties.

If you are not using Android Studio, reference this commit: https://github.com/brave/browser-android/commit/0fa9f58286e0679ec5772e19b995d6a508907691

##Telling getlocalization.com about new strings
## Telling getlocalization.com about new strings

1. Periodically upload the file `./Application/LinkBubble/src/main/res/values/strings.xml` to [getlocalization.com](https://www.getlocalization.com/LinkBubble/files/). getlocalization.com will determine which strings are new
2. When prompted on getlocalization.com, press the mark for retranslation (or keep existing) for changed strings.

##Getting new translated strings from getlocalization.com
## Getting new translated strings from getlocalization.com

1. Install npm dependencies with `npm install`.
2. Run `npm run translate <username> <password>` to pull down the translated xml files.
3. Commit and push your change.

Remember to uncomment `checkStrings` from `MainApplication` and call it in `onCreate` to make sure the pulled files don't cause crashes with format specifiers.

##ADB
## ADB

If you don't have `adb` in your path add it to your `~/.bash_profile` or similar file:

`export PATH=/Users/<your-username>/Library/Android/sdk/platform-tools:$PATH`
export PATH=/Users/<your-username>/Library/Android/sdk/platform-tools:$PATH

- **Installing an apk onto your device:**
`adb install -r ./LinkBubble/build/outputs/apk/LinkBubble-playstore-release.apk`
- **Installing an apk onto your device:**

adb install -r ./LinkBubble/build/outputs/apk/LinkBubble-playstore-release.apk

- **Getting a list of devices:**
`adb devices`

adb devices