Permalink
Browse files

Updating readme and documentation:

  • Loading branch information...
1 parent 72a2832 commit 63cbd45955bc55ad62804eae073ca7de4488761d @robhawkes robhawkes committed Feb 2, 2014
Showing with 80 additions and 12 deletions.
  1. +27 −1 CONTRIBUTING.md
  2. +11 −2 DATA-FORMATTING.md
  3. +42 −9 README.md
View
@@ -1 +1,27 @@
-# Contributing to ViziCities
+# Contributing to ViziCities
+
+[Like Ghost](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md)
+
+## Raising issues
+
+### Bug reports
+
+### Feature requests
+
+### Change requests
+
+
+## Working on ViziCities
+
+
+## Contributor license agreement
+
+__TL;DR: If you contribute to ViziCities then you accept that your work will become part of an MIT-licensed project and therefore may also be used on a for-profit basis. You should also have all rights to the work you contribute.__
+
+By contributing your code to ViziCities you grant ViziCities (Robin Hawkes and Peter Smart) a non-exclusive, irrevocable, worldwide, royalty-free, sublicenseable, transferable license under all of Your relevant intellectual property rights (including copyright, patent, and any other rights), to use, copy, prepare derivative works of, distribute and publicly perform and display the Contributions on any licensing terms, including without limitation: (a) open source licenses like the MIT license; and (b) binary, proprietary, or commercial licenses. Except for the licenses granted herein, You reserve all right, title, and interest in and to the Contribution.
+
+You confirm that you are able to grant us these rights. You represent that You are legally entitled to grant the above license. If Your employer has rights to intellectual property that You create, You represent that You have received permission to make the Contributions on behalf of that employer, or that Your employer has waived such rights for the Contributions.
+
+You represent that the Contributions are Your original works of authorship, and to Your knowledge, no other person claims, or has the right to claim, any right in any invention or patent related to the Contributions. You also represent that You are not legally obligated, whether by entering into an agreement or otherwise, in any way that conflicts with the terms of this license.
+
+ViziCities (Robin Hawkes and Peter Smart) acknowledges that, except as explicitly described in this Agreement, any Contribution which you provide is on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
View
@@ -1,7 +1,16 @@
-# Data Formats for ViziCities Features
+# Data formats for ViziCities features
* How to format data to be read correctly by ViziCities
+* GeoJSON / TopoJSON with the following attributes (eg. height, etc)
## Buildings
-## Roads
+```
+{}
+```
+
+## Roads
+
+```
+{}
+```
View
@@ -1,48 +1,81 @@
# ViziCities
+__Bringing cities to life using the power of open data and the Web__
-* Introduction to ViziCities and what it is
+![](http://f.cl.ly/items/0r0u0t1c2g1o3U1y3r2x/vizicities-combined-ssao.jpg)
+[ViziCities](http://vizicities.com) is a 3D city and data visualisation platform, powered by WebGL. It's sole purpose is to change the way you look at cities and the data contained within them. It is the brainchild of [Robin Hawkes](http://twitter.com/robhawkes) and [Peter Smart](http://twitter.com/petewsmart) — [get in touch](#contact--community) if you'd like to discuss the project with them in more detail.
-## Current Features
+### What does it do?
+
+ViziCities aims to combine data visualisation with a 3D representation of a city to provide a better understanding what's going on. It's a powerful new way of looking at and understanding urban areas.
+
+Aside from seeing a city in 3D, here are some of the others things you'll have the power to do:
+
+* View public transport (eg. buses, trains, planes) [flowing around a city in realtime](https://vimeo.com/67869313)
+* Use vehicles powered by artificial intelligence to [perform realistic traffic simulation](https://vimeo.com/66512057)
+* Visualise [social data in realtime](https://vimeo.com/67872925)
+* Overlay historic and static data (eg. census data) using traditional techniques (eg. heatmaps)
+* And much more…
+
+
+### Further information
+
+In 2013, Peter and Robin spoke in detail about ViziCities at Front Trends.
+
+<iframe src="http://player.vimeo.com/video/66495599" width="722" height="406" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+
+For more information you should start here:
+
+* [ViziCities website](http://vizicities.com)
+* [ViziCities announcement article](http://rawkes.com/articles/vizicities-dev-diary-1)
+* [Videos of various ViziCities experiments](https://vimeo.com/channels/vizicities)
+
+
+## Current features
### 0.1.0
* Buildings
* Processing of geographic features into 3D objects using Web Workers
-## Future Features
+## Future features
* Tests and build status (TravisCI)
-## Getting Started
+## Getting started
+
+ViziCities is at an incredibly early stage right now, but it's usable if you know what you're doing. The follow steps should get you up and running without too much trouble.
### Building ViziCities
+To start off, you'll need to build ViziCities and get an up-to-date JavaScript file.
+
* Installing Grunt
* Installing NPM packages
* Building ViziCities with Grunt
* Serving examples using Grunt
-### Data Formats
+### Data formats
-* How to format data to be read by ViziCities
+Visualising geographic features lies at the core of ViziCities. To make sure features render correctly you'll need to [use the correct data formats](https://github.com/robhawkes/ViziCities/blob/master/DATA-FORMATTING.md).
### Using ViziCities
* Using the built in example
* Viewing your own city
-## Getting Involved
+## Getting involved
* Overview of contribution methods
* Link to contribution details, [like Ghost](https://github.com/TryGhost/Ghost#getting-involved)
-## Community
+## Contact & community
+* How to get in touch with us (email, Twitter)
* Where to find ViziCities devs and community, [like Ghost](https://github.com/TryGhost/Ghost#community)
@@ -52,7 +85,7 @@
* Don't want anything too prescriptive just yet
-## Copyright & License
+## Copyright & license
The MIT License (MIT)

0 comments on commit 63cbd45

Please sign in to comment.