Skip to content

Commit

Permalink
preparing 0.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
arose committed Apr 27, 2016
1 parent 9994543 commit 92edcc7
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 3 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Change Log
All notable changes to this project will be documented in this file, following the suggestions of [Keep a CHANGELOG](http://keepachangelog.com/). This project adheres to [Semantic Versioning](http://semver.org/).


## v0.1.0 - 2016-04-26
### Added
- Initial release
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@

The **M**acro**M**olecular **T**ransmission **F**ormat (MMTF) is a binary encoding of biological structures. For a general introduction to the format visit the [website](http://mmtf.rcsb.org/).

This repository holds the [specification](spec.md) of the format and a [test suite](test-suite/).

The following encoding/decoding libaries implementing the specification are available:

* [Java encoder/decoder](https://github.com/rcsb/mmtf-java)
* [JavaScript decoder](https://github.com/rcsb/mmtf-javascript)


## Version 0.1

* [See changelog](https://github.com/rcsb/mmtf/releases/tag/v0.1)
* [See specification](https://github.com/rcsb/mmtf/blob/v0.1/spec.md)
* [See test-suite](https://github.com/rcsb/mmtf/blob/v0.1/test-suite)
* [Download release](https://github.com/rcsb/mmtf/archive/v0.1.zip)
2 changes: 1 addition & 1 deletion spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# MMTF Specification

*INITIAL DRAFT* (to be replaced by the version number)
*Version*: v0.1

The **m**acro**m**olecular **t**ransmission **f**ormat (MMTF) is a binary encoding of biological structures. It includes the coordinates, the topology and associated data. Specifically, a large subset of the data in mmCIF or PDB files can be represented. Pronounced goals are a reduced file size for efficient transmission over the Internet or from hard disk to memory and fast decoding/parsing speed. Additionally the format aims to be easy to understand and implement to facilitates its dissemination. For testing encoder and decoder implementations a [test suite](test-suite/) is available.

Expand Down
2 changes: 2 additions & 0 deletions test-suite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

*WORK IN PROGRESS*

*Version*: v0.1

The test suite provides a number of files in different formats to facilitate testing and validations of encoder/decoder implementations. The formats are:

* MMTF (all fields are encoded according to the specification and serialized using MessagePack to a binary file)
Expand Down

0 comments on commit 92edcc7

Please sign in to comment.