Skip to content

Commit

Permalink
Release 2
Browse files Browse the repository at this point in the history
  • Loading branch information
dsehnal committed Jul 19, 2017
1 parent d4c0ea6 commit a53bbb3
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 29 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -68,14 +68,18 @@ 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

npm install -g gulp
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
Expand Down Expand Up @@ -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
----------
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.4.0-rc
2.4.0
5 changes: 5 additions & 0 deletions docs/migrating/1-to-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]``.

38 changes: 19 additions & 19 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -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"
}
}

0 comments on commit a53bbb3

Please sign in to comment.