updates

Author: Nico-Curti

.travis.yml

@@ -0,0 +1,8 @@
+os:
+  - linux
+  - osx
+
+script:
+  - chmod 777 ./install.sh
+  - travis_wait 120 ./install.sh -y
+  - source ~/.bashrc

LICENSE LICENSE.md

@@ -1,32 +1,66 @@
-| **Authors**  | **Project** |
-|:------------:|:-----------:|
-|   N. Curti   |   BlendNet  |
+| **Authors**                                     | **Project** | **Build Status**              |
+|:-----------------------------------------------:|:-----------:|
+|   [**N. Curti**](https://github.com/Nico-Curti) | **BlendNet**| **Linux/OSX** : [![travis]()](https://travis-ci.com/Nico-Curti/BlendNet) <br/> **Windows** : [![Windows]()]() |
+
+[![GitHub pull-requests](https://img.shields.io/github/issues-pr/Nico-Curti/BlendNet.svg?style=plastic)](https://github.com/Nico-Curti/BlendNet/pulls)
+[![GitHub issues](https://img.shields.io/github/issues/Nico-Curti/BlendNet.svg?style=plastic)](https://github.com/Nico-Curti/BlendNet/issues)
+
+[![GitHub stars](https://img.shields.io/github/stars/Nico-Curti/BlendNet.svg?label=Stars&style=social)](https://github.com/Nico-Curti/BlendNet/stargazers)
+[![GitHub watchers](https://img.shields.io/github/watchers/Nico-Curti/BlendNet.svg?label=Watch&style=social)](https://github.com/Nico-Curti/BlendNet/watchers)
 
 <a href="https://github.com/physycom">
 <div class="image">
 <img src="https://cdn.rawgit.com/physycom/templates/697b327d/logo_unibo.png" width="90" height="90">
 </div>
 </a>
 
-# Blender Network viewer
+# BlendNet
+### (Blender Network viewer)
 
-<a href="https://github.com/Nico-Curti/blend_net/blob/master/example/star_graph.png">
+<a href="https://github.com/Nico-Curti/BlendNet/blob/master/example/star_graph.png">
 <div class="image">
-<img src="https://github.com/Nico-Curti/blend_net/blob/master/example/star_graph.png" width="960" height="540">
+<img src="https://github.com/Nico-Curti/BlendNet/blob/master/example/star_graph.png" width="960" height="540">
 </div>
 </a>
 
-One of the biggest problem during graph visualization is to obtain good results in 3D environment. [Blender](https://www.blender.org/) software allow to create very beautifull 3D objects and it is very easy to use throw the python support.
+One of the biggest problem during graph visualization is to obtain good results in 3D environment. [Blender](https://www.blender.org/) software allows to create very beautiful 3D objects and it is very easy to use by Python API.
 
-**BlendNet** project include a simple python interface to Blender environment to draw network in 2D and 3D as required in the input file.
+**BlendNet** project include a simple single-file python interface to draw network in 2D and 3D using Blender support.
 
-## Installation
+1. [Why BlendNet?](#why)
+2. [Prerequisites](#prerequisites)
+3. [Installation](#installation)
+4. [Authors](#authors)
+5. [License](#license)
+6. [Contribution](#contribution)
+7. [Acknowledgments](#acknowledgments)
+8. [Citation](#citation)
+
+## Why BlendNet?
+
+Graph visualization is still an open problem in many applications.
+Commonly the problem is related to large graph visualization in which problems arise from the rendering of a large number of nodes and a greater number of links between them.
+An other open problem concern the multi-dimensional visualization of the graphs.
+Despite the most common graph tools compute the node coordinates in a any space dimensions (and clearly the maximum number of possible dimension for a visualization is still three) the real visualization is often allowed only a 2D space.
+The counterpart of these problems concern the pretty visualization of the graphs that it is often ignored in many tools but it can be guarantee a good result, the so called wow-effect, in a presentation.
+
+BlendNet is a custom tool written in Python with the help of Blender API.
+Blender is now a standard in the 3D rendering and it is commonly used in a wide range of graphical applications, starting from the simpler 3D dynamics to the video-games applications.
+Blender is certainly more than a simple graphical viewer but the easy Python interface and the wide on-line documentation and blogs make it a useful tool for graphical representation of 3D structures.
 
-The scripts [install.sh](https://github.com/Nico-Curti/blend_net/blob/master/install.sh) and [install.ps1](https://github.com/Nico-Curti/blend_net/blob/master/install.ps1) cover a full installation example of Blender and project dependencies for Unix and Windows users, respectivelly.
+## Prerequisites
 
-## How to use
+**BlendNet** package uses Blender to render the network structure so install it before use it.
+A full list of Blender instruction can be found [here](https://www.blender.org/download/).
 
-The [Makefile](https://github.com/Nico-Curti/blend_net/blob/master/Makefile) cover a list of examples and command lines instructions about different inputs available. Just type `make help` to see the full list of available rules:
+Then you have to update the list of packages of the Python version inside Blender.
+So go to the `path_to_blender/version/python/bin` directory and download `pip` as package manager and use it to install `networkx` `pandas` `matplotlib` `numpy` or use the [requirements.txt]() file inside the project as `pip install -r path_to_BlendNet/requirements.txt`.
+
+## Installation
+
+The scripts [install.sh](https://github.com/Nico-Curti/BlendNet/blob/master/install.sh) and [install.ps1](https://github.com/Nico-Curti/BlendNet/blob/master/install.ps1) cover a full installation example of Blender and project dependencies for Unix and Windows users, respectively. To use it please download also the submodules of the project. The full list of dependencies will be installed as no-root users so any trouble about user-privileges is ignored.
+
+The [Makefile](https://github.com/Nico-Curti/BlendNet/blob/master/Makefile) cover a list of examples and command lines instructions about different inputs available. Just type `make help` to see the full list of available rules:
 
 ```bash
 **Blender viewer for graph**
@@ -57,14 +91,42 @@ To beginner:
 
 A list of examples could be found in [example](https://github.com/Nico-Curti/blend_net/tree/master/example) directory.
 
-## Contributions
-
-Any contribution is more than welcome. Just fill an issue or a pull request and I will check ASAP!
 
 ## Authors
 
 * **Nico Curti** [git](https://github.com/Nico-Curti), [unibo](https://www.unibo.it/sitoweb/nico.curti2)
 
+See also the list of [contributors](https://github.com/Nico-Curti/walkers/contributors) who participated in this project.
+
+
 ## License
 
-This project is released under GPL license. [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://github.com/Nico-Curti/blend_net/blob/master/LICENSE)
+The `BlendNet` package is licensed under the GPL License. [![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/Nico-Curti/BlendNet/blob/master/LICENSE.md)
+
+## Contribution
+
+Any contribution is more than welcome :heart:. Just fill an issue or a pull request and I will check ASAP!
+
+## Acknowledgments
+
+Thanks goes to all contributors of this project:
+
+| [<img src="https://avatars0.githubusercontent.com/u/9303827?s=400&v=4" width="100px;"/><br /><sub><b>Alessandro Fabbri</b></sub>](https://github.com/allefabbri) | [<img src="https://avatars2.githubusercontent.com/u/721187?s=400&v=4" width="100px;"/><br /><sub><b>Stefano Sinigardi</b></sub>](https://github.com/cenit)
+|:---:|:---:|
+
+and to Raffaele Pepe who help me with Blender instructions.
+
+### Citation
+
+If you have found `BlendNet` helpful in your research, please consider citing the
+
+```tex
+@misc{BlendNet,
+  author = {Nico Curti},
+  title = {{B}lend{N}et},
+  year = {2019},
+  publisher = {GitHub},
+  howpublished = {\url{https://github.com/Nico-Curti/BlendNet}},
+}
+```
+

README.md

@@ -0,0 +1,31 @@
+image: Visual Studio 2017
+clone_folder: c:\projects\BlendNet
+
+environment:
+    WORKSPACE: C:\projects
+    matrix:
+    - platform: Win64
+      COMPILER: vs
+      MSVC_SETUP_ARG: x64
+      PYTHON: "C:\\Python36-x64"
+      PYTHON_VERSION: "3.6.3"
+      PYTHON_ARCH: "64"
+      MINICONDA: "C:\\Miniconda36-x64"
+
+install:
+  # Use Miniconda to accelerate the build (max time for CI is 60 minutes!)
+  - "SET PATH=%MINICONDA%;%MINICONDA%\\Scripts;%PATH%"
+  - "python -m pip install -U pip"
+  - "python --version"
+  - "pip --version"
+  - "SET PROFILE=C:\\Users\\appveyor\\Documents\\WindowsPowerShell\\Microsoft.PowerShell_profile.ps1"
+
+  - git submodule -q update --init --recursive
+
+before_build:
+  - cd C:\projects\BlendNet
+
+build_script:
+  - ps: .\install.ps1 -y
+
+