From 27795affed92d74ca1b610bb79ca0d813ba7a402 Mon Sep 17 00:00:00 2001 From: Paolo Berto Durante Date: Sun, 2 Jul 2017 08:30:03 +0900 Subject: [PATCH] updates to readme --- LICENSE-multiverse-3rdparty.txt | 2 +- LICENSE-multiverse.txt | 2 +- README.md | 26 ++++++++++++++++++-------- 3 files changed, 20 insertions(+), 10 deletions(-) diff --git a/LICENSE-multiverse-3rdparty.txt b/LICENSE-multiverse-3rdparty.txt index b663a02c..b0325f3c 100755 --- a/LICENSE-multiverse-3rdparty.txt +++ b/LICENSE-multiverse-3rdparty.txt @@ -1367,7 +1367,7 @@ Milliways Milliways - the storage at the backend of the Multiverse - Copyright 2016 J CUBE Inc. Tokyo, Japan. + Copyright 2017 J CUBE Inc. Tokyo, Japan. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/LICENSE-multiverse.txt b/LICENSE-multiverse.txt index b8d8c92d..cafbcc63 100755 --- a/LICENSE-multiverse.txt +++ b/LICENSE-multiverse.txt @@ -2,7 +2,7 @@ Multiverse — a next generation storage back-end for Alembic - Copyright 2015—2016 J CUBE Inc. Tokyo, Japan. + Copyright 2015—2017 J CUBE Inc. Tokyo, Japan. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index ac23ae39..9c705435 100755 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # Multiverse -Next generation data storage back-end for the widely used Alembic file format. -> Authors: Aghiles Kheffache, Marco Pantaleoni, Bo Zhou, Paolo Berto Durante. +Multiverse is the next-generation data storage back-end for the widely used Alembic file format. + +> Authors: Marco Pantaleoni, Aghiles Kheffache, Bo Zhou, Paolo Berto Durante. + ## Repository organization The original upstream Alembic code resides in the [master](https://github.com/j-cube/multiverse/tree/master) branch. -The `Multiverse` code for the `2.0.0` release, resides in its own [2.0.0/multiverse](https://github.com/j-cube/multiverse/tree/2.0.0/multiverse) branch and is the default landing branch for the repository when browsing on GitHub. +In terms of version numbering, `Multiverse` stays in-sync with the Alembic releases: + +the `Multiverse` code for the `1.7.1` release, resides in its own [1.7.1/multiverse](https://github.com/j-cube/multiverse/tree/1.7.1/multiverse) branch and is the default landing branch for the repository when browsing on GitHub. To use `Multiverse`, just checkout its branch: @@ -15,12 +19,9 @@ To use `Multiverse`, just checkout its branch: $ git clone https://github.com/j-cube/multiverse.git ... -$ git checkout 2.0.0/multiverse +$ git checkout 1.7.1/multiverse ``` -Note that both `Multiverse` code for `1.5.8` and `2.0.0` releases match Alembic API 1.5.8 and these branch could be merged and even fast-forwarded on the upstream `1.5.8` tag. - -Support for Alembic API v1.6+ will be added after SIGGRAPH 2016. ## Multiverse dependencies @@ -30,6 +31,15 @@ In addition to the original Alembic dependencies, `Multiverse` needs the followi * [msgpack 1.0.1+](https://github.com/msgpack/msgpack-c/releases/download/cpp-1.0.1/msgpack-1.0.1.tar.gz) * [boost 1.48.0+](http://sourceforge.net/projects/boost/files/boost/1.48.0/boost_1_48_0.tar.bz2/download) compiled also with `chrono`, `filesystem`, `system` (in addition to the original `program_options`, `thread` and `python`) +### "Classic" Git and Milliways + +`Multiverse` source contains [Milliways](https://github.com/j-cube/milliways) "The storage at the back-end of the Multiverse". Milliways is a high-performance on-disk tree-based key-value store, used in Multiverse as an optional pluggable back-end to `libgit2`. `Milliways` was created to improve performance over the "classic" Multiverse Git backend by introducing a single file store database. As of release 1.7.1 we default to Milliways and a single .abc file is created, making the Git repository non visible to the user. CLassic Git repository can always be created optionall. + + +## Research + +`Multiverse` and `Milliways` are research projects by J CUBE Inc. Multiverse was published at SIGGRAPH Asia 2015 in Kobe, Japan. MOre information on [J CUBE Research](http://j-cube.jp/research). + ## Multiverse license `Multiverse` modifications and additions are: @@ -37,7 +47,7 @@ In addition to the original Alembic dependencies, `Multiverse` needs the followi ``` Multiverse - a next generation storage back-end for Alembic -Copyright 2015—2016 J CUBE Inc. Tokyo, Japan. +Copyright 2015—2017 J CUBE Inc. Tokyo, Japan. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.