From 027449383525e134d688878b046a834f50a3a5e3 Mon Sep 17 00:00:00 2001
From: Charles Wang <c_w@berkeley.edu>
Date: Mon, 7 Oct 2019 07:52:42 -0700
Subject: [PATCH] updating readme

---
 README.md                 | 18 +++++++++++-------
 src/preparedata/README.md |  2 +-
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index e0c0ca1..46a6d33 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,16 @@
-# <img src="docs/Logo/Logo.png" height="80"> Building recognition using AI at large-scale.
+# <img src="https://raw.githubusercontent.com/NHERI-SimCenter/BRAILS/master/docs/Logo/Logo.png" alt="logo" height="80"/> Building Recognition using AI at Large-Scale.
 
-<img src="docs/images/pipeline-left.png" height="230"><img src="docs/images/BIM3D.gif" height="230">
+<img src="https://raw.githubusercontent.com/NHERI-SimCenter/BRAILS/master/docs/images/pipeline-left.png" alt="BRAILS" height="230"/>
+<img src="https://raw.githubusercontent.com/NHERI-SimCenter/BRAILS/master/docs/images/BIM3D.gif" height="230">
 
+#
 
-AI-Based Pipeline for City-scale Building Information Modeling
+## What is BRAILS?
 
-# 
+BRAILS is the acronym for Building Recognition using AI at Large-Scale, 
+which is an AI-Based pipeline for city-scale building information modeling (BIM).
+
+## How to use?
 
 ###### Tested with Tensorflow in Python 3.6.6 
 
@@ -96,17 +101,16 @@ Use [*SURF*](https://github.com/charlesxwang/SURF) to predict missing building i
 <img src="docs/images/occupancy_Predictions_classification_error.png" width="700">
 
 
-### 5. Release of BIM data
+## Release of BIM data
 SimCenter will post obtained data here.
 ##### City-scale BIM for Atlantic coastal cities, NJ -> [Download](https://berkeley.box.com/shared/static/5tb6gszbbyj35bgpypk1gsdem0ntt5ca.geojson)
 <img src="docs/images/AtlanticCities.png" width="700">
 <img src="docs/images/BIM-demo.png" width="700">
 
-### 6. Release of trained CNN  
+## Release of trained CNN  
 Trained CNNs in the format of Tensorflow checkpoint will be posted here.
 ##### Roof type classifier ->[Download](https://berkeley.box.com/shared/static/awyyc22sjwknn9xg3p7wru4v5zwnlkjp.zip)
 
----
 
 ## How to Cite
 You can cite this software as follows:
diff --git a/src/preparedata/README.md b/src/preparedata/README.md
index a781755..42f2486 100644
--- a/src/preparedata/README.md
+++ b/src/preparedata/README.md
@@ -39,7 +39,7 @@ For this demo, we have prepared this boundary file for you, download [here](http
 
 Computer generated building footprints database -> [USBuildingFootprints](https://github.com/microsoft/USBuildingFootprints)
 
-We have prepared a cleaned version that just contains Atlantic coastal cities, download [here](https://berkeley.box.com/shared/static/0ueibjzbo1b0mgru4h6n8l2rmww8nx0z.geojson)
+We have prepared a cleaned version that just contains Atlantic coastal cities, download [here](https://berkeley.box.com/shared/static/0ueibjzbo1b0mgru4h6n8l2rmww8nx0z.geojson).
 
 Define the path of this footprints file in src/configure.py like this:
 ```