Skip to content

Commit

Permalink
Update project files: README, LICENSE, CHANGELOG
Browse files Browse the repository at this point in the history
* Remove all non-root instances of LICENSE and CHANGELOG

* Merge all README.md files into a single one, which contains the single
  source of truth for information about the project.

  - All other README.md contain just a minimal description of the
    current subdirectory.
  • Loading branch information
j1elo committed Jan 18, 2023
1 parent 7dc264d commit e5516d2
Show file tree
Hide file tree
Showing 234 changed files with 293 additions and 26,318 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Changes are published as Release Notes in the documentation.
Source files are located here: doc-kurento/source/project/relnotes/
And the web page is here: https://doc-kurento.readthedocs.io/en/latest/project/relnotes/
2 changes: 1 addition & 1 deletion server/module-elements/LICENSE → LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2023 Kurento

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion clients/java/NOTICE → NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(C) Copyright 2016 Kurento (https://kurento.openvidu.io/)
Copyright 2023 Kurento

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
120 changes: 120 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
[![Kurento logo](https://secure.gravatar.com/avatar/21a2a12c56b2a91c8918d5779f1778bf?s=120)](https://kurento.openvidu.io/)



# Kurento Media Server

| :house:[Homepage](https://kurento.openvidu.io/) | :books:[Documentation](https://kurento.openvidu.io/documentation) | [![Docker Pulls](https://img.shields.io/docker/pulls/kurento/kurento-media-server?color=blue&label=Docker&logo=docker&logoColor=blue)](https://hub.docker.com/r/kurento/kurento-media-server) |
| --- | --- | --- |
| [![GitHub commits](https://img.shields.io/github/commits-difference/Kurento/kurento?base=eabf6de352fb927df91baa2ec26794dac8c64d78&head=HEAD&label=Commits&logo=github)](https://github.com/Kurento/kurento/graphs/commit-activity) | [![GitHub contributors](https://img.shields.io/github/contributors/Kurento/kurento?label=Contributors&logo=github)](https://github.com/Kurento/kurento/graphs/contributors) | ![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/kurento?color=orange&label=Stack%20Overflow&logo=stackoverflow&logoColor=orange) |

Kurento Media Server is responsible for media transmission, processing, loading and recording. It is implemented in low level technologies based on the GStreamer multimedia toolkit, and provides the following features:

* Networked streaming protocols, including HTTP, RTP and WebRTC.
* Group communications (MCU and SFU functionality) supporting both media mixing and media routing/dispatching.
* Generic support for Computer Vision and Augmented Reality filters (OpenCV).
* Media storage supporting writing operations for WebM and MP4 and playback in all formats supported by GStreamer.
* Automatic media transcoding between any of the codecs supported by GStreamer including VP8, H.264, H.263, AMR, OPUS, Speex, G.711, etc.



## About Kurento

Kurento is an open source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities. To know more about Kurento, please visit the project website: https://kurento.openvidu.io/.

All source code belonging to the Kurento project can be found in the [Kurento GitHub organization page](https://github.com/Kurento).



## FIWARE Platform

[![FIWARE Chapter](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/media-streams.svg)](https://www.fiware.org/developers/catalogue/)
[![FIWARE Member Status](https://nexus.lab.fiware.org/static/badges/statuses/kurento.svg)](https://www.fiware.org/developers/catalogue/)
:mortar_board: [FIWARE Academy](https://fiware-academy.readthedocs.io/en/latest/processing/kurento)

The Kurento project is part of [FIWARE]. For more information check the FIWARE documentation for [Real-Time Media Stream Processing](https://fiwaretourguide.readthedocs.io/en/latest/processing/kurento/introduction/).

Kurento has been rated within [FIWARE] as follows:

- **Version Tested:**
![](https://img.shields.io/badge/dynamic/json.svg?label=Version&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.version&colorB=blue)
- **Documentation:**
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Completeness&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.docCompleteness&colorB=blue)
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Usability&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.docSoundness&colorB=blue)
- **Responsiveness:**
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Time%20to%20Respond&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.timeToCharge&colorB=blue)
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Time%20to%20Fix&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.timeToFix&colorB=blue)
- **FIWARE Testing:**
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Tests%20Passed&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.failureRate&colorB=blue)
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Scalability&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.scalability&colorB=blue)
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Performance&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.performance&colorB=blue)
![ ](https://img.shields.io/badge/dynamic/json.svg?label=Stability&url=https://fiware.github.io/catalogue/json/kurento.json&query=$.stability&colorB=blue)

Kurento is also part of the [NUBOMEDIA](https://nubomedia.readthedocs.io/en/latest/) research initiative.

The Open API specification, also known as [Kurento Protocol](https://doc-kurento.readthedocs.io/en/latest/features/kurento_api.html), is available at [Stream-oriented Open API](http://docs.streamoriented.apiary.io/).

[FIWARE]: https://www.fiware.org/



## Documentation

Kurento provides detailed [documentation](https://kurento.openvidu.io/documentation) including tutorials, installation and development guides.



## Useful Links

Usage:

* [Installation Guide](https://doc-kurento.readthedocs.io/en/latest/user/installation.html)
* [Docker Image](https://hub.docker.com/r/kurento/kurento-media-server)
* [Contribution Guide](https://doc-kurento.readthedocs.io/en/latest/project/contribute.html)
* [Developer Guide](https://doc-kurento.readthedocs.io/en/latest/dev/dev_guide.html)

Issues:

* [Bug Tracker](https://github.com/Kurento/kurento/issues)
* [Support](https://doc-kurento.readthedocs.io/en/latest/user/support.html)

News:

* [Kurento Blog](https://kurento.openvidu.io/blog)
* [Community Discussion](https://groups.google.com/forum/#!forum/kurento)

Training:

* [Kurento tutorials](https://doc-kurento.readthedocs.io/en/latest/user/tutorials.html)



## Testing

Kurento has a full set of different tests mainly focused in the integrated and system tests, more specifically e2e tests that anyone can run to assess different parts of Kurento, namely functional, stability, tutorials, and API.

In order to assess properly Kurento from a final user perspective, a rich suite of E2E tests has been designed and implemented. To that aim, the Kurento Testing Framework (KTF) has been created. KTF is a part of the Kurento project aimed to carry out end-to-end (E2E) tests for Kurento. KTF has been implemented on the top of two well-known open-source testing frameworks: JUnit and Selenium.

If you want to know more about the Kurento Testing Framework and how to run all the available tests for Kurento you will find more information in [Kurento developers documentation > Testing](https://doc-kurento.readthedocs.io/en/latest/dev/testing.html).



## License

[![License badge](https://img.shields.io/github/license/Kurento/kurento?label=License&logo=apache)](https://www.apache.org/licenses/LICENSE-2.0)

```
Copyright 2023 Kurento
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
202 changes: 0 additions & 202 deletions browser/kurento-utils-js/LICENSE

This file was deleted.

13 changes: 0 additions & 13 deletions browser/kurento-utils-js/NOTICE

This file was deleted.

Loading

0 comments on commit e5516d2

Please sign in to comment.