#38: documentation wip

CHANGELOG.md

@@ -0,0 +1,46 @@
+# Palladio ChangeLog
+
+## v1.0 (Jan 26, 2018)
+* Renamed project to "Palladio".
+* Updated documentation.
+
+## v9.0 (Jan 18, 2018)
+* Add support for writing out primitive attributes from rule/generic CGA attributes (#40).
+* Removed random seed parameter UI, read it from incoming primitive attributes instead. Added centroid-based random seed as fallback.
+* Correctly update assign node parameters from RPK (#62).
+* Make primitive group creation optional and based on primitive classifier (#67).
+* Add support for CityEngine network licensing (#41).
+* Fixed crash when handling invalid RPK paths.
+* Remove style prefix on primitive attribute names.
+
+## v0.8 (Dec 19, 2017)
+* Added support for multiple UV sets (#36).
+* Added support for CGA reports (#39).
+* Properly use Houdini input mesh connectivity (make CGA operation "isClosedSurface" work correctly) (#49).
+* Refactored assign node to correctly use incoming geometry to evaluate default rule attribute values.
+
+## v0.7.1 (Nov 27, 2017)
+* Proper support for UVs and material attributes.
+* Introduced Conan to handle 3rd part packages (Houdini, CityEngine).
+* Updated to CityEngine SDK 2017.1 (CE SDK 1.9).
+
+## v0.7 (Sep 19, 2017)
+* Split plugin into two SOPs ("assign" and "generate") to support proper evaluation of rule attribute default values.
+* Purely rely on Houdini attribute tools (e.g. "AttributeCreate") to create/modify rule attributes (= no need for complicated UI on assign node).
+* Updated to Houdini 16 and CityEngine 2017.
+* Dropped Windows support temporarily.
+
+## v0.6 (Mar 15, 2016)
+* Support for rule attribute UI via Houdini multi-parameter.
+* Experimental support for Windows.
+* Updated to Houdini 15 and CityEngine 2016.
+
+## v0.4 (Oct 22, 2015)
+* Working geometry generation (no normals/UVs) from CityEngine rule packages
+* Support to read rule attributes from primitive attributes
+* Implemented rule execution as single surface operator (SOP).
+* Updated to Houdini 13 and CityEngine 2015.
+
+## v0.1 - v0.3 (Spring 2015)
+* Early experiments with Houdini 12 and CityEngine 2014.
+* Figuring out how to represent CityEngine concept within the Houdini HDK data structures.

README.md

@@ -1,27 +1,34 @@
 # Palladio
 
-Palladio is a SideFX Houdini plugin. It provides custom Surface Operators which enable the execution of Esri CityEngine CGA rules within Houdini networks. This provides a convenient combination of the generic procedural modelling capabilities of Houdini with the architecture-specific procedural modeling language of CityEngine.
+Palladio is a plugin for [SideFX Houdini](https://www.sidefx.com). It provides custom operator nodes which enable the execution of [Esri CityEngine](http://www.esri.com/software/cityengine) rules within Houdini networks. This provides a convenient combination of the generic procedural modelling capabilities of Houdini with the architecture-specific procedural modeling language of CityEngine.
 
 ## Documentation
+
 * [Quick Start](USAGE.md)
 * [Building Palladio](BUILD.md)
 * [ChangeLog](CHANGELOG.md)
 
+External documentation:
+* [CityEngine Tutorials](http://desktop.arcgis.com/en/cityengine/latest/tutorials/introduction-to-the-cityengine-tutorials.htm)
+* [CityEngine CGA Reference](http://desktop.arcgis.com/en/cityengine/latest/cga/cityengine-cga-introduction.htm)
+* [CityEngine SDK API Reference](https://esri.github.io/esri-cityengine-sdk/html/index.html)
+* [Houdini 16.0 HDK Reference](http://www.sidefx.com/docs/hdk16.0/)  
+
 ## Community
 
-Palladio is maintained by Matthias Buehler (vrbn.io) and Simon Haegler (Esri R&D Zurich). For Palladio, Matthias is focusing on UX/UI topics and use cases in Urban Planning, while Simon is focusing on the implementation and procedural modelling.
+Palladio is maintained as an open-source project by Matthias Buehler (vrbn.io) and Simon Haegler (Esri R&D Zurich). Matthias is focusing on UX/UI topics and use-cases in Urban Planning, while Simon is focusing on the implementation and procedural modelling technology.
 
 Our goal is to bring as many Houdini and CityEngine users and developers on board as possible. Anyone is invited to fork and contribute to this project.
 
 ## History
 
-Palladio has been invented by Matthias Buehler and Simon Haegler in early 2015 as part of an experiment to test out the CityEngine SDK APIs and to see if Houdini and CityEngine could be integrated more tightly than just via file-based import/export. Early results were promising and we were slowly cooking the project to the point of not embarrassing ourselves by open-sourcing it publicly.
+Palladio has been invented by Matthias Buehler and Simon Haegler in early 2015 as part of an experiment to test out the CityEngine SDK APIs and to see if Houdini and CityEngine could be integrated more tightly than just via file-based import/export. Early results were promising and we were slowly cooking the project to v1.0 and took the decision to open-source it.
 
 
 ## Licensing
 
 Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
+you may not use this work except in compliance with the License.
 You may obtain a copy of the License at
 
 > http://www.apache.org/licenses/LICENSE-2.0