From a53bbb36e86a6c338f6aac11158921c73d84fbb2 Mon Sep 17 00:00:00 2001 From: dave Date: Wed, 19 Jul 2017 21:28:34 +0200 Subject: [PATCH] Release 2 --- README.md | 18 +++++++++--------- VERSION | 2 +- docs/migrating/1-to-2.md | 5 +++++ package.json | 38 +++++++++++++++++++------------------- 4 files changed, 34 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 6bdbae8..bf0d726 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -[![Version](https://img.shields.io/badge/Version-2.4.0_rc-blue.svg?style=flat)](CHANGELOG.md) -[![Latest Release](https://img.shields.io/badge/Latest%20Release-1.0-blue.svg?style=flat)](https://github.com/dsehnal/LiteMol/releases/tag/v1.0) +[![Version](https://img.shields.io/badge/Version-2.4.0-blue.svg?style=flat)](CHANGELOG.md) +[![Latest Release](https://img.shields.io/badge/Latest%20Release-2-blue.svg?style=flat)](https://github.com/dsehnal/LiteMol/releases/tag/v2) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat)](https://github.com/dsehnal/LiteMol/blob/master/LICENSE) ![Logo](web/assets/img/lm_logo_small.png) @@ -68,7 +68,7 @@ See the [Examples folder](examples). Building ======== -Install Node.js (tested on version 6.4.0). +Install Node.js (tested on version 8). LiteMol is written in TypeScript and needs to be compiled to JavaScript before use. To build it, use @@ -76,6 +76,10 @@ LiteMol is written in TypeScript and needs to be compiled to JavaScript before u npm install gulp +On Windows, it might be required to install the package `windows-build-tools` before the `npm intall` command: + + npm install windows-build-tools -g + Any subsequent full LiteMol builds can be done using just the command gulp @@ -127,25 +131,21 @@ Currently, our priority is to improve these things: Releases -------- -The latest stable release of LiteMol is the [version 1.0](https://github.com/dsehnal/LiteMol/releases/tag/v1.0). +The latest stable release of LiteMol is the [version 2](https://github.com/dsehnal/LiteMol/releases/tag/v2). -Currently, the version 2.0 is being developed and is in a "release candidate" phase and should be released soon. Migration summary can be found [here](docs/migrating/1-to-2.md). Short term goals --------- -These features are planned to be introduced during 2017. +These features are planned to be introduced in version 3: **Core features** * Improving extension support: * Streamline the process of extension creation. * Support for dynamic extension loading. - * _Will require breaking changes._ * Support for saving and restoring the state of the application. - * _Will require breaking changes._ * Improved internal data representation of molecules. - * _Will require breaking changes._ Long term goals ---------- diff --git a/VERSION b/VERSION index 90cc008..9183195 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.4.0-rc \ No newline at end of file +2.4.0 \ No newline at end of file diff --git a/docs/migrating/1-to-2.md b/docs/migrating/1-to-2.md index 4dafc44..4184671 100644 --- a/docs/migrating/1-to-2.md +++ b/docs/migrating/1-to-2.md @@ -93,3 +93,8 @@ Density Data The parameter ``normalized`` has been removed from the ``LiteMol.Bootstrap.Entity.Transformer.Density.ParseDataParams`` interface. +Vectors +======= + +Any "LiteMol object vector" of the form ``{ x, y, z}`` should now be represented as a 3 element array ``[x, y, z]``. + diff --git a/package.json b/package.json index 3f9f70f..82173c7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "litemol", - "version": "2.4.0-rc", + "version": "2.4.0", "description": "A library/plugin for handling 3D structural molecular data (not only) in the browser.", "scripts": {}, "main": "index.js", @@ -28,23 +28,23 @@ ], "license": "Apache-2.0", "devDependencies": { - "@types/gulp": "^3.8.33", - "byline": "^5.0.0", - "gulp": "^3.9.1", - "gulp-clean": "^0.3.2", - "gulp-concat": "^2.6.1", - "gulp-gzip": "^1.4.0", - "gulp-insert": "^0.5.0", - "gulp-rename": "^1.2.2", - "gulp-replace": "^0.6.1", - "gulp-sass": "^3.1.0", - "gulp-tar": "^2.0.0", - "gulp-typedoc": "^2.0.2", - "gulp-uglify": "^2.1.2", - "gulp-util": "^3.0.8", - "merge2": "^1.1.0", - "ts-node": "^3.2.0", - "typedoc": "^0.7.1", - "typescript": "^2.4.1" + "@types/gulp": "~3.8.33", + "byline": "~5.0.0", + "gulp": "~3.9.1", + "gulp-clean": "~0.3.2", + "gulp-concat": "~2.6.1", + "gulp-gzip": "~1.4.0", + "gulp-insert": "~0.5.0", + "gulp-rename": "~1.2.2", + "gulp-replace": "~0.6.1", + "gulp-sass": "~3.1.0", + "gulp-tar": "~2.0.0", + "gulp-typedoc": "~2.0.2", + "gulp-uglify": "~2.1.2", + "gulp-util": "~3.0.8", + "merge2": "~1.1.0", + "ts-node": "~3.2.0", + "typedoc": "~0.7.1", + "typescript": "~2.4.1" } } \ No newline at end of file