feat: readme update

This commit is contained in:
Swann Martinez 2019-09-30 17:01:56 +02:00
parent 28d5b684ef
commit 573f4e813c
No known key found for this signature in database
GPG Key ID: 414CCAFD8DA720E1
3 changed files with 11 additions and 17 deletions

View File

@ -16,27 +16,21 @@ This tool aims to allow multiple users to work on the same scene over the networ
Settings are under: `View3D -> Sidebar -> Multiuser`
![settings](medias/settings.png)
### 1. Set user infos
| Host | Join |
| :---: | :---: |
| ![host_panel](medias/host.png) | ![join_panel](medias/join.png) |
| Start empty: Cleanup the file before starting to host | IP: host ip |
| | Port: host port |
![settings](medias/user.png)
### Host a session
:warning: If you host a session over internet, special network configuration is needed :warning:
- **name**: username.
- **color**: color used to represent the user into other user workspaces.
![host_panel](medias/host.png)
### 2. setup network
| Host | Join |
| :----------------------------------------------------------------------------------------------- | :----------------------------- |
| ![host_panel](medias/host.png) | ![join_panel](medias/join.png) |
| Start empty: Cleanup the file before starting to host | IP: host ip |
| :warning: If you host a session over internet, special network configuration is needed :warning: | Port: host port |
- Start empty: Cleanup the file before starting to host
### Join a session
![join_panel](medias/join.png)
- IP: host ip
- Port: host port
## Current development statut

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

BIN
medias/user.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB