aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephan Schmitz <eyecatchup@gmail.com>2014-10-28 16:25:39 +0100
committerStephan Schmitz <eyecatchup@gmail.com>2014-10-28 16:25:39 +0100
commit985a8a337c0d5cafee89192457d5b86078308179 (patch)
tree3724eaa6d256974c9f7070a283763eca28569c23
parent3f0af56a894acf5c2ebf740c0197d39a04b0278d (diff)
downloadiosched-985a8a337c0d5cafee89192457d5b86078308179.tar.gz
Properly format text to 80 cols limit in building doc.
-rw-r--r--doc/BUILDING.md34
1 files changed, 18 insertions, 16 deletions
diff --git a/doc/BUILDING.md b/doc/BUILDING.md
index 27c142a..ccc1b75 100644
--- a/doc/BUILDING.md
+++ b/doc/BUILDING.md
@@ -70,12 +70,13 @@ This is a Gradle-based project that works best with [Android Studio].
6. Add your debug keystore to the project (save it as android/debug.keystore),
or modify the build.gradle file to point to your key.
- > __NOTE__: In debug mode, you sign your app with a debug certificate generated
- by the Android SDK. This certificate has a private key and a known password.
- To sign your app in release mode, you need to generate your own certificate.
- If you haven't done so, please refer to the [App Signing] guide for further
- details. If you wish to build with Android Wear support, please refer to the
- [Packaging Wearable Apps] guide for further details.
+ > __NOTE__: In debug mode, you sign your app with a debug certificate
+ generated by the Android SDK. _(This certificate has a private key and a
+ known password.)_ To sign your app in release mode, you need to generate
+ your own certificate. If you haven't done so yet, please refer to the
+ [App Signing] guide for further details. Also, if you wish to build with
+ Android Wear support, for further details please refer to the guide
+ [Packaging Wearable Apps].
7. Choose Build > Make Project in Android Studio or run the following
command in the project root directory:
@@ -101,11 +102,11 @@ changes below.
# Server-side setup
-> __NOTE__: These steps are optional, in the sense that IOSched will build and run even if
- you don't set up the server side. However, unless you perform this setup, your
- build won't be able to use any of the Google APIs such as Google sign in, Google
- Drive integration, Google Maps integration, etc. So following the instructions
- in this section is highly recommended.
+> __NOTE__: These steps are optional, in the sense that IOSched will build and
+ run even if you don't set up the server side. However, unless you perform
+ this setup, your build won't be able to use any of the Google APIs such as
+ Google sign in, Google Drive integration, Google Maps integration, etc. So
+ following the instructions in this section is highly recommended.
1. Change the project's package name to your own package name. To do that, you
can set the "package" attribute of the <manifest> tag in AndroidManifest.xml.
@@ -142,11 +143,12 @@ certificate fingerprint, run the following command (on Windows, substitute
keytool -exportcert -alias your-key-name \
-keystore /path/to/your/release/keystore/file -list -v
```
- > __NOTE__: In order to create a Client ID, you might be required to set up the
- consent screen first! _(The screen that will be shown to users whenever you
- request access to their private data using your Client ID.)_ To do so, go to
- "APIs and auth" > "Consent screen", enter a "PRODUCT NAME" and click "Save".
- Finally, go back to Step 5 to create your Client ID(s).
+ > __NOTE__: In order to create a Client ID, you might be required to set up
+ the consent screen first! _(That's the screen that will be shown to
+ users whenever you request access to their private data using your
+ Client ID.)_ To do so, go to "APIs and auth" > "Consent screen", enter a
+ "PRODUCT NAME" and click "Save". Finally, go back to Step 5 to create
+ your Client ID(s).
6. Still at the "Credentials" page, create an API Key for Public API access.
As a key type use _"Key for Android applications"_, and you should add both your