Skip to content

Commit 21d52ae

Browse files
author
yngrtc
committed
update README
1 parent 8144153 commit 21d52ae

File tree

5 files changed

+14
-11
lines changed

5 files changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@
3333

3434
- [Building](#building)
3535
- [Toolchain](#toolchain)
36-
- [Monorepo Setup](#monorepo-setup)
36+
- [Build](#build)
3737
- [Open Source License](#open-source-license)
3838
- [Contributing](#contributing)
39+
3940
</details>
4041

4142
#
@@ -46,31 +47,33 @@
4647

4748
SFU.rs currently requires Rust 1.75.0+ to build.
4849

49-
### Monorepo Setup
50+
### Build
5051

51-
All [RTC](https://github.com/webrtc-rs/rtc/) protocols are added as [submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) of this repository under /rtc/.
52+
To build sfu crate:
5253

5354
```
54-
git clone https://github.com/webrtc-rs/sfu
55-
cd sfu
56-
git submodule update --init --recursive
55+
cargo build [or clippy or test or fmt]
5756
```
5857

59-
To build sfu crate:
58+
To build sync version chat examples:
6059

6160
```
62-
cargo build [or clippy or test or fmt]
61+
cargo run --package sfu --example sync_chat
6362
```
6463

65-
To build chat examples:
64+
To build async version chat examples:
6665

6766
```
68-
cargo run --package sfu --example sync_chat
6967
cargo run --package sfu --example async_chat
7068
```
7169

7270
## Open Source License
73-
Dual licensing under both MIT and Apache-2.0 is the currently accepted standard by the Rust language community and has been used for both the compiler and many public libraries since (see https://doc.rust-lang.org/1.6.0/complement-project-faq.html#why-dual-mitasl2-license). In order to match the community standards, SFU.rs is using the dual MIT+Apache-2.0 license.
71+
72+
Dual licensing under both MIT and Apache-2.0 is the currently accepted standard by the Rust language community and has
73+
been used for both the compiler and many public libraries since (
74+
see https://doc.rust-lang.org/1.6.0/complement-project-faq.html#why-dual-mitasl2-license). In order to match the
75+
community standards, SFU.rs is using the dual MIT+Apache-2.0 license.
7476

7577
## Contributing
78+
7679
Contributors or Pull Requests are Welcome!!!

test-data/output.h264

-2.45 MB
Binary file not shown.

test-data/output.ogg

-1.33 MB
Binary file not shown.

test-data/output_vp8.ivf

-250 KB
Binary file not shown.

test-data/output_vp9.ivf

-219 KB
Binary file not shown.

0 commit comments

Comments
 (0)