Added installation instructions and prerequisites

README.md

@@ -2,11 +2,29 @@
 
 > Convert images and videos into a cartoon!
 
-The webapp is deployed here - 
+The webapp is deployed here - cartoonize-lkqov62dia-de.a.run.app
+
+## Prerequisites for Google Cloud and Algorithmia
+
+**These are important steps if you want to leverage Google buckets, signed URLs and Algorithmia's platform.**
+
+### Cloud Run authentication
+To use any functionalities pertaining to Google Cloud, you'll need a global authentication file (JSON). You can obtain this JSON by following the steps given here - [Getting started with authentication](https://cloud.google.com/docs/authentication/getting-started)
+
+After you get the JSON file, rename it to `token.json` (so that it's compatible with the codebase). 
+
+Set the environment variable in your terminal -
+```
+export GOOGLE_APPLICATION_CREDENTIALS="/path/to/token.json"
+```
+**Notes**:
+- You can set it permanently by adding this line to `~/.bashrc`.
+- `Dockerfile` already includes the setting of this particular environment variable. :)
 
-## Installation
 
-### Prerequisites for Google Cloud and Algorithmia
+### Algorithmia
+
+## Installation
 
 ### Using Docker
 
@@ -16,12 +34,13 @@ The easiest way to get the webapp running is by using the Dockerfile:
 ```
 docker build -t cartoonize .
 ```
+**Note**: Set the appropriate values in `config.yaml` before building the image.
+
 2. Run the container by exposing the appropriate ports
 ```
 docker run -p 8080:8080 cartoonize
 ```
 
-**Note**: In the `Dockerfile`, you'll have to change the port in the `gunicorn` command to `8080` to make the above instruction work! The value `$PORT` pertains to Google Cloud Run requirements.
 
 ### Using `virtualenv`
 
@@ -34,9 +53,22 @@ source cartoonize/bin/activate
 ```
 pip install -r requirements.txt
 ```
-3. Run the webapp (run locally unless you have cloud run and algorithmia setup)
+3. Run the webapp. Be sure to set the appropriate values in `config.yaml` file before running the application.
 ```
-python app.py --run_local 1
+python app.py
 ```
 
 ## License
+
+1. Copyright © Cartoonizer ([Demo webapp](https://cartoonize-lkqov62dia-de.a.run.app/))
+
+    - Authors: [Niraj Pandkar](https://twitter.com/Niraj_pandkar) and [Tejas Mahajan](https://twitter.com/tjdevWorks).
+
+    - Licensed under the [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode) 
+    - Commercial application is prohibited by license
+
+
+2. Copyright (C) Xinrui Wang, Jinze Yu. ([White box cartoonization](https://github.com/SystemErrorWang/White-box-Cartoonization))
+    - All rights reserved. 
+    - Licensed under the CC BY-NC-SA 4.0 
+    - Also, Commercial application is prohibited license (https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode).