vizicities/README.md

53 wiersze
939 B
Markdown

# ViziCities
* Introduction to ViziCities and what it is
## Current Features
### 0.1.0
* Buildings
* Processing of geographic features into 3D objects using Web Workers
## Future Features
* Tests and build status (TravisCI)
## Getting Started
### Building ViziCities
* Installing Grunt
* Installing NPM packages
* Building ViziCities with Grunt
* Serving examples using Grunt
### Using ViziCities
* Using the built in example
* Viewing your own city
## Getting Involved
* Overview of contribution methods
* Link to contribution details, [like Ghost](https://github.com/TryGhost/Ghost#getting-involved)
## Community
* Where to find ViziCities devs and community, [like Ghost](https://github.com/TryGhost/Ghost#community)
## Versioning
* Potentially use [Ghost versioning text](https://github.com/TryGhost/Ghost#versioning)
* Don't want anything too prescriptive just yet
## Copyright & License
* Paste license here