Merge pull request #79 from w3-engineers/feature/readme-license

Feature/Change the images of Telemesh screens with the latest images
w3-engineers · Nov 26, 2019 · 999b1da · 999b1da
2 parents 0d4c09e + b0553a7
commit 999b1da
Show file tree

Hide file tree

Showing 22 changed files with 34 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -6,10 +6,11 @@
 
 # Telemesh
 
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE-OF-CONDUCT.md)
 [![Build Status](https://travis-ci.com/w3-engineers/telemesh.svg?branch=master)](https://travis-ci.com/w3-engineers/telemesh)
+[![docs](https://readthedocs.org/projects/pip/badge/?version=latest&style=flat)](https://readthedocs.org/projects/telemesh/)
 [![Coverage Status](https://coveralls.io/repos/github/w3-engineers/telemesh/badge.svg?branch=master)](https://coveralls.io/github/w3-engineers/telemesh?branch=master)
 [![Lint tool: TeleMesh](https://img.shields.io/badge/Lint_tool-telemesh-2e99e9.svg?style=flat)](https://w3-engineers.github.io/telemesh/lint_reports/lint-report.html)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE-OF-CONDUCT.md)
 
 A mesh network based off-grid messaging application powered by blockchain technology.
 
@@ -40,14 +41,16 @@ If you face any bug or have any particular feature request please go [here](http
 
 **NOTE:** You must have a connected device or emulator as it runs instrumentation tests. You will find the coverage report at *telemesh/app/build/reports/coverage*
 
-## User Interface (UI)
-<kbd><img src="http://gdurl.com/CxzW" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/Znvi" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/exAY" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/Q0-C" width="175" height="300"></kbd> 
 
-<kbd><img src="http://gdurl.com/Un2g" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/wmHS" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/G9N1" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/0vRW" width="175" height="300"></kbd> 
 
-<kbd><img src="http://gdurl.com/IbR1" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/fKqZ" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/gIwO" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/cUI2" width="175" height="300"></kbd>
+## User Interface (UI)
+
+Please find here the complete UI flow [Telemesh UI](https://xd.adobe.com/view/102f0226-2937-4d2e-6ec0-e7e82c164fa1-661e/grid)
 
-<kbd><img src="http://gdurl.com/cDhEu" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/xEb6" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/59rC" width="175" height="300"></kbd> <kbd><img src="http://gdurl.com/A2Qj" width="175" height="300"></kbd>
+<kbd><img src="http://gdurl.com/vjIz" width="175" height="300"></kbd> 
+<kbd><img src="http://gdurl.com/uZ08" width="175" height="300"></kbd> 
+<kbd><img src="http://gdurl.com/TMGD" width="175" height="300"></kbd> 
+<kbd><img src="http://gdurl.com/9oMM" width="175" height="300"></kbd> 
 
 
 

diff --git a/docs/source/android_core.rst b/docs/source/android_core.rst
@@ -1,4 +1,4 @@
-.. android_core:
+.. _android_core:
 
 Android Core
 ------------

diff --git a/docs/source/app_architecture.rst b/docs/source/app_architecture.rst
@@ -1,4 +1,4 @@
-.. app_architecture:
+.. _app_architecture:
 
 TeleMesh App Architecture
 -------------------------

diff --git a/docs/source/background.rst b/docs/source/background.rst
@@ -1,4 +1,4 @@
-.. background:
+.. _background:
 
 
 Background

diff --git a/docs/source/create_branch.rst b/docs/source/create_branch.rst
@@ -1,4 +1,4 @@
-.. create_branch:
+.. _create_branch:
 
 Create branch
 -------------

diff --git a/docs/source/data_management.rst b/docs/source/data_management.rst
@@ -1,4 +1,4 @@
-.. data_management:
+.. _data_management:
 
 Data Management
 ---------------

diff --git a/docs/source/development_step_by_step.rst b/docs/source/development_step_by_step.rst
@@ -1,4 +1,4 @@
-.. development_step_by_step:
+.. _development_step_by_step:
 
 Telemesh
 ---------------------------------

diff --git a/docs/source/features.rst b/docs/source/features.rst
@@ -1,4 +1,4 @@
-.. features:
+.. _features:
 
 Features
 --------

diff --git a/docs/source/get_started.rst b/docs/source/get_started.rst
@@ -1,4 +1,4 @@
-.. get_started:
+.. _get_started:
 
 Get started
 -----------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,9 +14,9 @@ Telemesh Documentation
    features
    project_structure
    prerequisities
+   project_dependencies
    get_started
    create_branch
-   project_dependencies
    local_dev_env
    development_guideline
 

diff --git a/docs/source/local_dev_env.rst b/docs/source/local_dev_env.rst
@@ -1,4 +1,4 @@
-.. local_dev_env:
+.. _local_dev_env:
 
 Local development environments
 ------------------------------

diff --git a/docs/source/prerequisities.rst b/docs/source/prerequisities.rst
@@ -1,8 +1,8 @@
-.. prerequisities:
+.. _prerequisities:
 
-=============
-Prerequisites
-=============
+=========================
+Development Prerequisites
+=========================
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/project_dependencies.rst b/docs/source/project_dependencies.rst
@@ -1,4 +1,4 @@
-project_dependencies
+.. _project_dependencies
 
 Project Dependencies
 --------------------
@@ -7,6 +7,7 @@ Telemesh project has a dependency on wireless `Mesh technology`_ and `Blockchain
 
 This project has core dependency on another open-source project `Viper`_ which will
 provide support for Mesh and Blockchain functionalities and expose set of api to ease development work.
+Please follow the :ref:`Viper Guideline <viper_intro>`
 
 
 .. _Blockchain Technology: https://blockgeeks.com/guides/what-is-blockchain-technology/

diff --git a/docs/source/project_goal.rst b/docs/source/project_goal.rst
@@ -1,4 +1,4 @@
-.. project_goal:
+.. _project_goal:
 
 Project’s Goal
 --------------

diff --git a/docs/source/project_structure.rst b/docs/source/project_structure.rst
@@ -1,4 +1,4 @@
-.. project_structure:
+.. _project_structure:
 
 Project’s Structure
 -------------------

diff --git a/docs/source/testing.rst b/docs/source/testing.rst
@@ -1,4 +1,4 @@
-.. testing:
+.. _testing:
 
 Testing
 -------

diff --git a/docs/source/user_interface.rst b/docs/source/user_interface.rst
@@ -1,4 +1,4 @@
-.. user_interface:
+.. _user_interface:
 
 User Interface
 --------------

diff --git a/docs/source/viper.rst b/docs/source/viper.rst
@@ -1,4 +1,4 @@
-.. viper:
+.. _viper:
 
 =====
 Viper

diff --git a/docs/source/viper_intro.rst b/docs/source/viper_intro.rst
@@ -1,4 +1,4 @@
-.. viper_intro:
+.. _viper_intro:
 
 
 Viper Introduction

diff --git a/docs/source/viper_mesh_support.rst b/docs/source/viper_mesh_support.rst
@@ -1,4 +1,4 @@
-.. viper_mesh_support:
+.. _viper_mesh_support:
 
 
 Mesh Support

diff --git a/docs/source/viper_ui_ux.rst b/docs/source/viper_ui_ux.rst
@@ -1,4 +1,4 @@
-.. viper_ui_ux:
+.. _viper_ui_ux:
 
 
 UI/UX Support

diff --git a/docs/source/viper_wallet_support.rst b/docs/source/viper_wallet_support.rst
@@ -1,4 +1,4 @@
-.. viper_wallet_support:
+.. _viper_wallet_support:
 
 
 Wallet Support