πŸ‘‹ Fix broken image in Readme and improve it

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2022-11-09 08:50:52 +01:00
parent 57f6a80153
commit cf74e0cac5
No known key found for this signature in database
GPG key ID: 74434EFE0D2E2205
2 changed files with 29 additions and 31 deletions

View file

@ -15,7 +15,7 @@
More in the works for the [coming versions](https://github.com/nextcloud/spreed/milestones/).
If you have suggestions or problems, please [open an issue](https://github.com/nextcloud/spreed/issues) or contribute directly :)
If you have suggestions or problems, please [open an issue](https://github.com/nextcloud/spreed/issues) or contribute directly πŸ€“
### Supported Browsers
@ -32,7 +32,7 @@ If you have suggestions or problems, please [open an issue](https://github.com/n
Nextcloud Talk is really easy to install. You just need to enable the app from the [Nextcloud App Store](https://apps.nextcloud.com/apps/spreed) and everything will work out of the box.
There are some scenarios (users behind strict firewalls / symmetric NATs) where a TURN server is needed. That's a bit more tricky to install. You can [find instructions in our documentation](https://nextcloud-talk.readthedocs.io/en/latest/TURN/) and the team behind the Nextcloud VM has developed a script which takes care of everything for you ([vm-talk.sh](https://github.com/nextcloud/vm/blob/master/apps/talk.sh)). The script is tested on Ubuntu Server 18.04, but should work on 16.04 as well. Please keep in mind that it's developed for the VM specifically and any issues should be reported in that repo, not here.
There are some scenarios (users behind strict firewalls / symmetric NATs) where a TURN server is needed. That's a bit more tricky to install. You can [find instructions in our documentation](https://nextcloud-talk.readthedocs.io/en/latest/TURN/) and the team behind the Nextcloud VM has developed a script which takes care of everything for you ([vm-talk.sh](https://github.com/nextcloud/vm/blob/master/apps/talk.sh)). The script is tested on the recent Ubuntu Server LTS. Please keep in mind that it's developed for the VM specifically and any issues should be reported in that repository, not here.
Here's a short [video](https://youtu.be/KdTsWIy4eN0) on how it's done.
@ -76,44 +76,42 @@ If you need to use Talk in an enterprise environment, [contact our sales team](h
## Development Setup
1. Simply clone this repository into the `apps` folder of your Nextcloud development instance.
2. Run `make dev-setup` to install the dependencies.
3. Run `make build-js`.
4. Then activate it through the apps management. :tada:
5. To build the docs locally, install mkdocs locally: `apt install mkdocs mkdocs-bootstrap`.
1. πŸ—‚οΈ Simply clone this repository into the `apps` folder of your Nextcloud development instance.
2. πŸ“¦ Run `make dev-setup` to install the dependencies.
3. πŸ—οΈ Run `make build-js`.
4. πŸ”Œ Then activate it through the apps management. :tada:
5. πŸ“˜ To build the docs locally, install mkdocs locally: `apt install mkdocs mkdocs-bootstrap`.
We are also available on [our public Talk team conversation](https://cloud.nextcloud.com/call/c7fz9qpr), if you want to join the discussion.
### API documentation
The API documentation is available [here](https://nextcloud-talk.readthedocs.io/en/latest/).
### Milestones and Branches
#### Branches
In the Talk app we have one branch per Nextcloud server version. stable* branches of the app should always work with the same branch of the Nextcloud server.
This is only off close to releases of the server, to allow easier finishing of features, so we don't have to backport them.
#### Milestones
* 10.0.0 - **Numeric** milestones are settled and waiting for their release or some final polishing
* πŸ’› Next Minor (20) - The **next minor** milestone is for issues/PR that go into the next Dot-Release for the given Nextcloud version (in the example 20 - e.g. 10.0.1)
* πŸ’š Next Major (21) - The **next major** milestone is for issues/PR that go into the next feature release for the new Major Nextcloud version (as there are Minors for 20, this would be 21)
* πŸ’” Backlog - The **backlog** milestone is assigned to all remaining issues
You can always pick a task of any of the milestones and we will help you to get it into the assigned milestone or also an earlier one if time permits. It's just a matter of having an overview and better visibility what we think should be worked on, but it's not exclusive.
### Useful tricks for testing
* Disable camera until reboot: `sudo modprobe -r uvcvideo`
* Re-enable camera: `sudo modprobe uvcvideo`
* Send fake-stream (audio and video) in Firefox:
1. Open `about:config`
2. Search for `fake`
3. Toggle `media.navigator.streams.fake` to **true**
1. Open `about:config`
2. Search for `fake`
3. Toggle `media.navigator.streams.fake` to **true**
### API documentation
The API documentation is available on [nextcloud-talk.readthedocs.io/](https://nextcloud-talk.readthedocs.io/en/latest/).
### Milestones and Branches
#### Branches
In the Talk app we have one branch per Nextcloud server version. `stable*` branches of the app should always work with the same branch of the Nextcloud server.
This is only off close to releases of the server, to allow easier finishing of features, so we don't have to backport them.
#### Milestones
* `10.0.0` - **Numeric** milestones are settled and waiting for their release or some final polishing
* `πŸ’› Next Minor (20)` - The **next minor** milestone is for issues/PR that go into the next Dot-Release for the given Nextcloud version (in the example 20 - e.g. 10.0.1)
* `πŸ’š Next Major (21)` - The **next major** milestone is for issues/PR that go into the next feature release for the new Major Nextcloud version (as there are Minors for 20, this would be 21)
* `πŸ’” Backlog` - The **backlog** milestone is assigned to all remaining issues
You can always pick a task of any of the milestones and we will help you to get it into the assigned milestone or also an earlier one if time permits. It's just a matter of having an overview and better visibility what we think should be worked on, but it's not exclusive.
## Contribution Guidelines

View file

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB