diff --git a/README.md b/README.md index a4915a4..567059a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This tool aims to allow multiple users to work on the same scene over the network. Based on a Clients / Server architecture, the data-oriented replication schema replicate blender data-blocks across the wire. -## Installation +## Quick installation 1. Download latest release [multi_user.zip](/uploads/8aef79c7cf5b1d9606dc58307fd9ad8b/multi_user.zip). 2. Run blender as administrator (dependencies installation). @@ -19,31 +19,32 @@ This tool aims to allow multiple users to work on the same scene over the networ ## Usage -See [how to](https://gitlab.com/slumber/multi-user/wikis/User/Quickstart) section. +See the [documentation](https://multi-user.readthedocs.io/en/latest/) for details. ## Current development status Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones. -| Name | Status | Comment | -| ---------- | :----------------: | :------------: | -| action | :x: | WIP | -| armature | :x: | WIP | -| camera | :white_check_mark: | | -| collection | :white_check_mark: | | -| curve | :white_check_mark: | Not tested | -| gpencil | :white_check_mark: | | -| image | :exclamation: | Not stable yet | -| mesh | :white_check_mark: | | -| material | :white_check_mark: | | -| metaball | :x: | | -| object | :white_check_mark: | | -| scene | :white_check_mark: | | -| world | :white_check_mark: | | +| Name | Status | Comment | +| ----------- | :----------------: | :------------: | +| action | :exclamation: | Not stable | +| armature | :exclamation: | Not stable | +| camera | :white_check_mark: | | +| collection | :white_check_mark: | | +| curve | :white_check_mark: | Not tested | +| gpencil | :white_check_mark: | | +| image | :exclamation: | Not stable yet | +| mesh | :white_check_mark: | | +| material | :white_check_mark: | | +| metaball | :white_check_mark: | | +| object | :white_check_mark: | | +| scene | :white_check_mark: | | +| world | :white_check_mark: | | +| lightprobes | :white_check_mark: | | ### Performance issues -Since this addon is written in pure python for a prototyping purpose, performances could be better from all perspective. +Since this addon is written in pure python for a research purpose, performances could be better from all perspective. I'm working on it. ## Dependencies @@ -58,12 +59,10 @@ I'm working on it. ## Contributing -1. Fork it () -2. Create your feature branch (`git checkout -b feature/fooBar`) -3. Commit your changes (`git commit -am 'Add some fooBar'`) -4. Push to the branch (`git push origin feature/fooBar`) -5. Create a new Pull Request +See [contributing section](https://multi-user.readthedocs.io/en/latest/ways_to_contribute.html) of the documentation. ## Licensing -See [license](LICENSE) \ No newline at end of file +See [license](LICENSE) + +[![Documentation Status](https://readthedocs.org/projects/multi-user/badge/?version=latest)](https://multi-user.readthedocs.io/en/latest/?badge=latest)