Update README.md
[wren/.git] / README.md
index df398c09525bd32acd0389414d889feb2324c501..c63673a8d016790ebf04d49e56a90a153e3e1c88 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
-# WikiHouse Wren
+### IMPORTANT: This is now an outdated, unsupported WikiHouse system. For the latest WikiHouse core system info please see the [Skylark repo](https://github.com/wikihouseproject/Skylark) and [WikiHouse guides](https://www.wikihouse.cc/guides)
 
-The language and rules for the Wikihouse structural system for 1-3 storey buildings, initially developed in the UK for European contexts.
+
+# Wren
+
+The language and rules for the Wren Wikihouse structural system, suitable for 1-3 storey buildings and initially developed in the UK for European contexts.
 
 ![alt tag](https://github.com/wikihouseproject/Wren/blob/master/Images/Wren_overview.jpg)
 
@@ -8,20 +11,20 @@ The language and rules for the Wikihouse structural system for 1-3 storey buildi
 
 Wren components are CNC manufuctured using structural-grade timber panel materials (typically, plywood) and can be rapidly assembled to produce a structural chassis, onto which other components such as cladding, windows, doors can be fitted.
 
-Wren is in development. For full documentation on how Wren works and how you can contribute to its development, visit the [Wren wiki](https://github.com/wikihouseproject/Wren/wiki)
+#### Wren is in development. For full documentation on how Wren works and how you can contribute to its development, visit the [Wren wiki](https://github.com/wikihouseproject/Wren/wiki)
 
 ## Wren Parametrics
 
 This version of the Wren structural language has been developed in Grasshopper, the parametric scripting plugin for Rhino 3D. This computational design platform is widely used in the design and construction industries, and is ideally suited to digital manufacturing.
 
-Other formats of the Wren system are currently being developed, but currently this version in Grasshopper XML format represents the latest thinking and workflow for the structural technology.
+Other formats of the Wren system are currently being developed, but currently this version in Grasshopper format represents the latest thinking and workflow for the structural technology.
 
 It should be taken as a Work in Progress and follows ‘a build something that works first’ approach. There are still several known areas where efficiency can be improved. There are also many ways the script can be extended to make use of Grasshopper’s expansive suite of tools include new features like structural analysis, nesting, GIS data, and solar/environmental tracking. We gladly welcome contributions from fellow computational designers to fork and develop!
 
 
 ### Licence
 
-The repository Grasshopper file WikiHouse_WREN_(v4.2.3) has been developed by Architecture 00.  
+The repository Grasshopper file WikiHouse_WREN_(v4.3) has been developed by Architecture 00.  
 
 It is licensed under Mozilla Public Licence (MPL) version 2.0. For full legal terms of this licence visit: https://www.mozilla.org/en-US/MPL/2.0/
 
@@ -38,14 +41,14 @@ The plugins used are:
 
 ### Known issues / limits
 
-- D-Joint splitting of the frame - there is currently a very basic version of the logic but this probably needs to be custom scripted. The basic rules are no section should be larger than the sheet material (nominally 1220 x 2440mm) and D-joints are never closer than two grips to any corner/junction
-- Integration with Google Sheets - While you can ‘drive’ the Wren script using the parameter sliders, the best way makes use of the Leafcutter plugin, which connects the script with a google spreadsheet for the input and output of project data. This is particularly handy when setting out the window and door sizes and locations.
-- Number of roof points - Here be bugs, it may not work for multiple roof points and may also break the frame/sheathing geometry. Use with care.
-- Tolerance - While tolerances can be added to slots in the 3D model, a much better/safer approach is to add tolerance offsets to the final nested cutting files, and keep the 3D geometry at 0mm tolerance.
-- Data structures - within the component clusters. This can be streamlined even further
+- **D-Joint splitting of the frame** - there is currently a very basic version of the logic but this probably needs to be custom scripted. The basic rules are no section should be larger than the sheet material (nominally 1220 x 2440mm) and D-joints are never closer than two grips to any corner/junction
+- **Integration with Google Sheets** - While you can ‘drive’ the Wren script using the parameter sliders, the best way makes use of the Leafcutter plugin, which connects the script with a google spreadsheet for the input and output of project data. This is particularly handy when setting out the window and door sizes and locations.
+- **Number of roof points** - Here be bugs, it may not work for multiple roof points and may also break the frame/sheathing geometry. Use with care.
+- **Tolerance** - While tolerances can be added to slots in the 3D model, a much better/safer approach is to add tolerance offsets to the final nested cutting files, and keep the 3D geometry at 0mm tolerance.
+- **Data Tree structures** - These can be streamlined much further within the Sheathing and Spacer component clusters to improve the file size/solution speed
 - Custom scripts - custom C# / Python scripts can and should be added to replace large sections of the script to improve the flow and speed up processing
-- End-walls (in development) - The gable end walls use the Wikihouse Weaver system (cassette-based) and still more development needed on an automated workflow here, specifically with how the front and rear facades are divided up around window openings. The parametric script for Weaver is not yet included in this initial release.
-- Notes/comments -  There’s a lack of these in the clusters and subclusters. More detail and comments will be added soon, my apologies! If you have particularly questions get in touch via email or raise an issue here.
+- **End-walls (in development)** - The gable end walls use the Wikihouse Weaver system (cassette-based) and still more development needed on an automated workflow here, specifically with how the front and rear facades are divided up around window openings. The parametric script for Weaver is not yet included in this initial release.
+- **Notes/comments** -  There’s a definite lack of these in the clusters and subclusters. More detail and comments will be added soon, my apologies! If you have particularly questions get in touch via email or raise an issue here.
 
 ## Wren Hardware R&D Contributions
 
@@ -85,8 +88,8 @@ The plugins used are:
 **Architecture 00** (www.architecture00.net)
 - [Clayton Prest](https://twitter.com/ClaytonPrest) 
 
-**Architype Architects**
-- Agneesh Brahmbhatt
+**Architype - Team Architects** (http://www.architype-ta.co.nz/)
+- [Agneesh Brahmbhatt](https://www.linkedin.com/in/agneesh-brahmbhatt-7557234?authType=NAME_SEARCH&authToken=MdJZ&locale=en_US&trk=tyah&trkInfo=clickedVertical%3Amynetwork%2CclickedEntityId%3A13733489%2CauthType%3ANAME_SEARCH%2Cidx%3A1-1-1%2CtarId%3A1482235340928%2Ctas%3Aag)
 
 If you believe you are missing from either of these lists of historical contributions, please contact us or fork this document to amend.