From c5678cbff09f370ae95498e71bc7feb37ea3476f Mon Sep 17 00:00:00 2001 From: Pedro Rodriguez Date: Tue, 8 Aug 2017 10:14:35 +0200 Subject: [PATCH] Improved open source docs (#997) --- CODE_OF_CONDUCT.md | 74 +++++++++++++++++++++++ CONTRIBUTING.md | 4 ++ nuve/README.md => LICENSE.md | 6 -- README.md | 19 +++--- erizo/README.md | 53 ---------------- erizoAPI/README.md | 113 ----------------------------------- erizo_controller/README.md | 13 ---- 7 files changed, 89 insertions(+), 193 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md rename nuve/README.md => LICENSE.md (96%) delete mode 100644 erizo/README.md delete mode 100644 erizoAPI/README.md delete mode 100644 erizo_controller/README.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..d05f4bc063 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..9b100e1616 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +# Contributing to Licode + +Thank you for considering contributing to Licode! +We keep an up-to-date guide in the [Licode web](http://lynckia.com/licode/contribute.html). diff --git a/nuve/README.md b/LICENSE.md similarity index 96% rename from nuve/README.md rename to LICENSE.md index e493f10b7f..dc5fc0f039 100644 --- a/nuve/README.md +++ b/LICENSE.md @@ -1,9 +1,3 @@ -# Nuve - -## License - -The MIT License - Copyright (C) 2012 Universidad Politecnica de Madrid. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.md b/README.md index 33f3c5bdfd..4224c39e63 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,21 @@ You have two options to start using Licode: * If you are interested in contributing, want to get a better view of the Licode architecture or you don't trust those fancy containers - [How to build Licode from source](http://licode.readthedocs.io/en/master/from_source/) +## Community Forums -More info at: -http://www.lynckia.com/licode +Most discussions take place in the [Licode discourse](http://discourse.lynckia.com/). Please feel free to jump in to discuss anything Licode or WebRTC related. This is also a good place to find answers for your Licode problems. -## License +## Contributing -The MIT License +You can find our contributing guide [here](http://lynckia.com/licode/contribute.html). -Copyright (C) 2012 Universidad Politecnica de Madrid. +## Code Of Conduct -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this [code](https://github.com/lynckia/licode/blob/master/CODE_OF_CONDUCT.md). -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +## License -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +[MIT License](https://github.com/lynckia/licode/blob/master/LICENSE.md). + +More info at: +http://www.lynckia.com/licode diff --git a/erizo/README.md b/erizo/README.md deleted file mode 100644 index 6e67eab80a..0000000000 --- a/erizo/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# Erizo, a C/C++ Multipoint Control Unit (MCU) Library for WebRTC -*Warning: This is the 'media' branch, it is highly unstable* - -Erizo is a project that aims to implement a library able to communicate with WebRTC (http://www.webrtc.org) browser clients in order to provide advanced communication services. Currently it is tested on Ubuntu 11.10 and above but it should be able to be compiled on other distributions. - -Updated code documentation can be found at http://ging.github.com/erizo - -## Directory structure - -- /src - The root source directory -- /src/erizo - The source of the main library -- /src/examples - Examples and tests - -## Requirements - -- CMake >= 2.8 -- libSRTP version >= 1.4.4 -- Libnice version >= 1.10 -- boost_threads >= 1.48 -- boost_regex >= 1.48 (optional, only for examples) -- boost_asio >= 1.48 (optional, only for examples) -- boost_system >= 1.48 (optional, only for examples) - -## Building Instructions - -This project is built using CMake. - -The easiest way to build it is to use the provided scripts: -- Run ./generateProject.sh to run cmake, test the dependencies and generate the Makefile. -- Run ./buildProject.sh to build the project after generating the Makefile. It simply runs make in the build directory. -- Run ./generateEclipseProject.sh to generate an Eclipse CDT project which can be imported and used to work with the code. - -If doxygen is availabe a "doc" target is generated. HTML documentation can be built by running "make doc" in the build directory. - -##Examples - -As of now, the only application built using the library is a streaming application that connects via TCP to a server application built on top of node.js. - -The node.js app is not released but the code should provide an example on how the SDP exchange is made. -The examples are unusable as of now, but they can help to understand the API. -In the future, we will include here tests and updated examples. - -## License - -The MIT License - -Copyright (C) 2012 Universidad Politecnica de Madrid. - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/erizoAPI/README.md b/erizoAPI/README.md deleted file mode 100644 index 343d823d42..0000000000 --- a/erizoAPI/README.md +++ /dev/null @@ -1,113 +0,0 @@ -# ErizoAPI, a Node.js addon wrapper for erizo, the MCU Library for WebRTC - -Erizo is a project that aims to implement a library able to communicate with WebRTC (http://www.webrtc.org) browser clients in order to provide advanced communication services. With ErizoAPI you can use easily erizo in your Node.js projects. - -## Requirements - -You must have built erizo in your computer in order to use erizoAPI.
-You can find erizo code at http://github.com/ging/erizo - -## Building Instructions - -1- Export the paths to get the source code and the library of erizo: - - - Main path to erizo - export ERIZO_HOME=path/to/erizo - - Path to liberizo.so - export LD\_LIBRARY\_PATH=path/to/erizo/build/erizo - -2- Execute build.sh - -##Usage - -With erizo you can publish and subscribe to WebRTC streams.
-First get the erizoAPI module. - -
-    var erizo = require('./path/to/erizoAPI/build/Release/addon');
-
- -OneToManyProcessor is the muxer that gets the published stream and sends it to the subscribers. With more than one OneToManyProcessor you can make multiconference services. - -
-    var muxer = new erizo.OneToManyProcessor();        
-
- -Also you need a WebRtcConnection for each participant (publisher or subscriber). - -
-    var wrtc = new erizo.WebRtcConnection();
-
- -Start the ICE negotiation and check periodically its state (the negotiation is asynchronous). When candidates are gathered (state > 0) set the client SDP. - -
-    wrtc.init();
-                           
-    var intervarId = setInterval(function() {
-
-        var state = wrtc.getCurrentState();
-
-        if(state > 0) {
-
-            wrtc.setRemoteSdp(remoteSdp);
-   
-            var localSdp = wrtc.getLocalSdp();
-
-            //Return localSdp to the client
-    
-            clearInterval(intervarId);
-        }
-
-    }, 100);
-
- -Finally return the local SDP to the client and the connection is stablished. - -Note that the way to interchange the SDPs between the client and erizo is out of the scope of this project. - - -###Publishing a stream - -To publish a stream add the publisher WebRtcConnection to the OneToManyProcessor - -
-    wrtc.setAudioReceiver(muxer);
-    wrtc.setVideoReceiver(muxer);
-    muxer.setPublisher(wrtc);
-
- - - -###Subscribing to a stream - -To subscribe to a stream add a subscriber WebRtcConnection to the OneToManyProcessor. OneToManyProcessor needs an unique peer identifier for each subscriber. - -
-    muxer.addSubscriber(wrtc, peerId);
-
- -In order to start correctly the communication send a FIR packet to the publisher. Make sure the ICE state is READY (wrtc.getCurrentState() > 2) - -
-    muxer.sendFIR();                    
-
- -Also you can remove a determined subscriber from the muxer - -
-    muxer.removeSubscriber(peerId);                    
-
- - -## License - -The MIT License - -Copyright (C) 2012 Universidad Politecnica de Madrid. - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/erizo_controller/README.md b/erizo_controller/README.md deleted file mode 100644 index b74bd9b1be..0000000000 --- a/erizo_controller/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Erizo Controller - -## License - -The MIT License - -Copyright (C) 2012 Universidad Politecnica de Madrid. - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.