Skip to content
This repository was archived by the owner on Oct 23, 2024. It is now read-only.

Commit 44c5243

Browse files
grgustafGeoff Gustafson
andauthored
Minor corrections to wording in README (#450)
Co-authored-by: Geoff Gustafson <[email protected]>
1 parent 4d42bbd commit 44c5243

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ The media server for OWT provides an efficient video conference and streaming se
1010
- Customer defined media analytics plugins to perform analytics on streams from MCU
1111
- The usage scenarios for real-time media stream analytics including but not limited to movement/object detection
1212

13-
## How to install develop dependency
13+
## How to install development dependencies
1414

15-
In the repository root, use one of following commands to install dependency.
15+
In the repository root, use one of following commands to install the dependencies.
1616
- Interactive mode: `scripts/installDeps.sh`
1717
- Non-interactive mode: `scripts/installDepsUnattended.sh`
1818
In interactive mode, you need type "yes" to continue installation several times and in non-interactive, the installation continues automatically.
1919

2020
## How to build release package
2121

2222
### Requirements
23-
The media server can be built on following platforms:
23+
The media server can be built on the following platforms:
2424
1. Ubuntu 18.04
2525
2. CentOS 7.6
2626

@@ -34,17 +34,17 @@ The ${webrtc-javascript-sdk-sample-conference-dist} is built from owt-javascript
3434
If "--archive ${name}" option is appended to the pack command, a "Release-${name}.tgz" file will be generated in root folder. For other options, run the scripts with "--help" option.
3535

3636
## Quick Start
37-
In the repository root, run following commands to start media server on single machine:
37+
In the repository root, run the following commands to start the media server on a single machine:
3838
1. `./bin/init-all.sh --deps`
3939
2. `./bin/start-all.sh`
4040
3. Open https://localhost:3004 to visit the web sample page. Due to the test certificate, you may need confirm this unsafe access.
4141

4242
## Where to find API documents
43-
See "doc/servermd/Server.md" and "doc/servermd/RESTAPI.md".
43+
See [doc/servermd/Server.md](doc/servermd/Server.md) and [doc/servermd/RESTAPI.md](doc/servermd/RESTAPI.md).
4444

4545
## Build a Docker image with your app
4646
Run the build_server.sh script located in docker/conference. It has one required flag, -p, which should contain the filepath of your app. Optional flags are -i for the final Docker image name, and -n
47-
which will make the Docker build run with --no-cache. An example usecase..
47+
which will make the Docker build run with --no-cache. An example usecase:
4848
```
4949
./docker/conference/build_server.sh -p ~/my_app -i myapp_img
5050
```
@@ -53,8 +53,7 @@ which will make the Docker build run with --no-cache. An example usecase..
5353
We warmly welcome community contributions to Open WebRTC Toolkit Media Server repository. If you are willing to contribute your features and ideas to OWT, follow the process below:
5454
- Make sure your patch will not break anything, including all the build and tests
5555
- Submit a pull request onto https://github.com/open-webrtc-toolkit/owt-server/pulls
56-
- Watch your patch for review comments if any, until it is accepted and merged
57-
OWT project is licensed under Apache License, Version 2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contributions under these terms.
56+
- Watch your patch for review comments, if any, until it is accepted and merged. The OWT project is licensed under Apache License, Version 2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contributions under these terms.
5857

5958
## How to report issues
6059
Use the "Issues" tab on Github.

0 commit comments

Comments
 (0)