Merge pull request #40 from dneg/upstream

Release AX 1.0.0 and migrate official AX support to OpenVDB ASWF

CHANGES.md

@@ -1,7 +1,15 @@
 OpenVDB AX Version History
 ==========================
 
-Version 1.0.0 - In Development
+Version 1.0.0 - January 18, 2021
+
+    This release coincides with the release of OpenVDB 8.0.0, where the core
+    OpenVDB AX library has been incorporated into the OpenVDB ASWF repository.
+    Future development will be focused in the OpenVDB ASWF repo. The standalone
+    OpenVDB AX repository is in maintenance mode.
+
+    See the official OpenVDB ASWF repository:
+        https://github.com/AcademySoftwareFoundation/openvdb
 
     New Features:
     - Introduced new error logging framework for AX syntax errors/warnings,

README.md

@@ -1,24 +1,21 @@
-# OpenVDB AX [![ax](https://github.com/dneg/openvdb_ax/workflows/ax/badge.svg)](https://github.com/dneg/openvdb_ax/actions)
+# OpenVDB AX
 
+* [Migration](#migration)
 * [Introduction](#introduction)
-* [Development Repository](#development-repository)
-    * [License](#license)
-    * [Documentation](#documentation)
-    * [Requirements](#requirements)
-    * [Developer Quick Start](#developer-quick-start)
-* [Roadmap](#roadmap)
+* [License](#license)
 
+## Migration
 
-## Introduction
+### **This repository is in maintenance mode.**
 
-OpenVDB AX is an open source C++ library that provides a powerful and easy way of interacting with [OpenVDB](http://www.openvdb.org/) point and volume data. This exposes an expression language to allow fast, custom manipulation of point attributes and voxel values using a collection of mathematical functions. Expressions are quickly JIT-compiled and to offer great performance that in many cases rival custom C++ operators. It is developed and maintained by DNEG, providing a flexible and portable way to work with OpenVDB data.
+As of OpenVDB AX 1.0.0 and OpenVDB 8.0.0, this repository has been merged into the [OpenVDB ASWF repository](https://github.com/AcademySoftwareFoundation/openvdb). All future development for OpenVDB AX will be focused there. It is strongly encouraged to use OpenVDB AX through the OpenVDB repository, which contains fixes, improvements and up to date documentation!
 
+See https://github.com/AcademySoftwareFoundation/openvdb
 
-## Development repository
 
-This repository hosts the latest developments in the OpenVDB AX repository. This has been used in production at DNEG in various feature films yet remains a work-in-progress and such may be quite volatile. That is, both API and ABI **may be subject to change** so development using more niche features and lower-level components of the library (close to the LLVM component) should be approached with caution. However, use of the library and AX language (i.e. through the provided vdb_ax binary and Houdini OpenVDB AX SOP) is encouraged and future developments will focus on extending the language further to offer a wider range of functionality.
+## Introduction
 
-For the latest changes please see our [change log](CHANGES.md).
+OpenVDB AX is an open source C++ library that provides a powerful and easy way of interacting with [OpenVDB](http://www.openvdb.org/) point and volume data. This exposes an expression language to allow fast, custom manipulation of point attributes and voxel values using a collection of mathematical functions. Expressions are quickly JIT-compiled and to offer great performance that in many cases rival custom C++ operators. It was originally developed and maintained by DNEG, providing a flexible and portable way to work with OpenVDB data.
 
 
 ### License
@@ -28,15 +25,10 @@ OpenVDB AX is released under the [Mozilla Public License Version 2.0](https://ww
 
 ### Requirements
 
-OpenVDB AX follows the same requirements as OpenVDB. For more information on required dependency versions, see the [OpenVDB Dependency Page](https://www.openvdb.org/documentation/doxygen/dependencies.html). Importantly, OpenVDB AX requires the following:
-
  * A C++ 14 Compiler
- * [OpenVDB 6.2.1](https://github.com/AcademySoftwareFoundation/openvdb/releases/tag/v6.2.1) or later
+ * [OpenVDB 7.0.0](https://github.com/AcademySoftwareFoundation/openvdb/releases/tag/v7.0.0) or later
  * [LLVM](https://llvm.org/). Though OpenVDB AX supports versions of LLVM >= 6.0, we recommend LLVM 8.0 which is the current version most used and tested against.
 
-### Documentation
-
-This library uses doxygen for creating its documentation. This documentation currently includes both developer and user documentation including language examples, syntax and list of available functions.
 
 ### Developer Quick Start
 
@@ -68,28 +60,6 @@ make install
 cd ../..
 ```
 
-##### Building OpenVDB
-```
-git clone --branch v6.2.1 https://github.com/AcademySoftwareFoundation/openvdb.git openvdb
-cd openvdb
-mkdir build
-cd build
-cmake ..
-make -j4
-make install
-```
-
-##### Building OpenVDB AX
-```
-git clone https://github.com/dneg/openvdb_ax.git openvdb_ax
-cd openvdb_ax
-mkdir build
-cd build
-cmake ..
-make -j4
-make install
-```
-
 #### macOS
 ##### Installing Dependencies (Boost, TBB, OpenEXR, Blosc)
 ```
@@ -115,9 +85,10 @@ make -j4
 make install
 cd ../..
 ```
-##### Building OpenVDB
+
+#### Building OpenVDB
 ```
-git clone --branch v6.2.1 https://github.com/AcademySoftwareFoundation/openvdb.git openvdb
+git clone https://github.com/AcademySoftwareFoundation/openvdb.git openvdb
 cd openvdb
 mkdir build
 cd build
@@ -126,7 +97,7 @@ make -j4
 make install
 ```
 
-##### Building OpenVDB AX
+#### Building OpenVDB AX
 ```
 git clone https://github.com/dneg/openvdb_ax.git openvdb_ax
 cd openvdb_ax
@@ -136,7 +107,3 @@ cmake ..
 make -j4
 make install
 ```
-
-## Roadmap
-
-Please see our [roadmap](ROADMAP.md) for more details.