2014-02-02 00:51:51 +00:00
|
|
|
# ViziCities
|
2014-02-01 11:40:05 +00:00
|
|
|
|
2014-02-01 14:42:55 +00:00
|
|
|
* Introduction to ViziCities and what it is
|
2014-02-01 11:40:05 +00:00
|
|
|
|
2014-02-02 11:02:55 +00:00
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
## Current Features
|
2014-02-01 11:40:05 +00:00
|
|
|
|
2014-02-02 01:01:25 +00:00
|
|
|
### 0.1.0
|
|
|
|
|
|
|
|
|
|
* Buildings
|
|
|
|
|
* Processing of geographic features into 3D objects using Web Workers
|
|
|
|
|
|
2014-02-02 11:02:55 +00:00
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
## Future Features
|
2014-02-01 11:40:05 +00:00
|
|
|
|
2014-02-02 01:01:25 +00:00
|
|
|
* Tests and build status (TravisCI)
|
|
|
|
|
|
2014-02-02 11:02:55 +00:00
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
## Getting Started
|
2014-02-01 11:40:05 +00:00
|
|
|
|
2014-02-02 11:02:55 +00:00
|
|
|
### Building ViziCities
|
|
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
* Installing Grunt
|
|
|
|
|
* Installing NPM packages
|
|
|
|
|
* Building ViziCities with Grunt
|
|
|
|
|
* Serving examples using Grunt
|
2014-02-01 11:40:05 +00:00
|
|
|
|
2014-02-02 13:57:16 +00:00
|
|
|
### Data Formats
|
|
|
|
|
|
|
|
|
|
* How to format data to be read by ViziCities
|
|
|
|
|
|
2014-02-02 11:02:55 +00:00
|
|
|
### Using ViziCities
|
|
|
|
|
|
|
|
|
|
* Using the built in example
|
|
|
|
|
* Viewing your own city
|
|
|
|
|
|
|
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
## Getting Involved
|
|
|
|
|
|
|
|
|
|
* Overview of contribution methods
|
|
|
|
|
* Link to contribution details, [like Ghost](https://github.com/TryGhost/Ghost#getting-involved)
|
|
|
|
|
|
2014-02-02 11:02:55 +00:00
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
## Community
|
|
|
|
|
|
|
|
|
|
* Where to find ViziCities devs and community, [like Ghost](https://github.com/TryGhost/Ghost#community)
|
|
|
|
|
|
2014-02-02 11:02:55 +00:00
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
## Versioning
|
|
|
|
|
|
|
|
|
|
* Potentially use [Ghost versioning text](https://github.com/TryGhost/Ghost#versioning)
|
2014-02-02 11:02:55 +00:00
|
|
|
* Don't want anything too prescriptive just yet
|
|
|
|
|
|
2014-02-02 00:51:51 +00:00
|
|
|
|
|
|
|
|
## Copyright & License
|
|
|
|
|
|
2014-02-02 13:49:44 +00:00
|
|
|
The MIT License (MIT)
|
|
|
|
|
|
|
|
|
|
Copyright (c) 2014 - Robin Hawkes & Peter Smart
|
|
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
|
|
|
copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
|
SOFTWARE.
|
