Skip to content

Commit

Permalink
[=] add guidance for building on MacOS, update dingtalk group image. (#…
Browse files Browse the repository at this point in the history
…351)

* [+] add guidance for building on macOS

* [=] update dingtalk group image
  • Loading branch information
Yanmei-Liu authored Oct 25, 2023
1 parent 7a8ff4c commit 25780c3
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 6 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To run test cases, you need

## QuickStart Guide

XQUIC supports both BabaSSL and BoringSSL.
XQUIC can be built with Tongsuo(BabaSSL) or BoringSSL.

### Build with BoringSSL

Expand All @@ -86,6 +86,7 @@ SSL_PATH_STR="${PWD}"
SSL_INC_PATH_STR="${PWD}/include"
SSL_LIB_PATH_STR="${PWD}/build/ssl/libssl.a;${PWD}/build/crypto/libcrypto.a"
cd ../..
## Note: if you don’t have golang in your environment, please install [golang](https://go.dev/doc/install) first.

# build XQUIC with BoringSSL
git submodule update --init --recursive
Expand Down Expand Up @@ -160,4 +161,4 @@ Feel free to contact us in the following ways:
* Dingtalk group: 34059705
* slack channel: #xquic in quicdev group

<img src="docs/images/dingtalk_group.jpg" width=200 alt="dingtalk group"/>
<img src="docs/images/dingtalk_group.png" width=200 alt="dingtalk group"/>
17 changes: 13 additions & 4 deletions docs/Platforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,29 @@ make -j

You can use the cmake variables `-DPLATFORM=mac` to build XQUIC on macOS.

Remember you still need to install BoringSSL or Tongsuo(BabaSSL) first, please follow to the guidance [get and build BoringSSL](https://github.com/alibaba/xquic#build-with-boringssl) / [get and build BabaSSL](https://github.com/alibaba/xquic#build-with-babassl).

```bash
# build XQUIC with BabaSSL

# build XQUIC with BoringSSL

git submodule update --init --recursive
mkdir build; cd build
cmake -DPLATFORM=mac ..
cmake -DPLATFORM=mac -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} -DSSL_INC_PATH=${SSL_INC_PATH_STR} -DSSL_LIB_PATH=${SSL_LIB_PATH_STR} -DXQC_SUPPORT_SENDMMSG_BUILD=0 ..
make -j

# build XQUIC with BoringSSL

# build XQUIC with BabaSSL
git submodule update --init --recursive
mkdir build; cd build
cmake -DPLATFORM=mac -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} -DSSL_INC_PATH=${SSL_INC_PATH_STR} -DSSL_LIB_PATH=${SSL_LIB_PATH_STR} ..
cmake -DPLATFORM=mac -DXQC_SUPPORT_SENDMMSG_BUILD=0 ..
make -j

```

Troubleshooting:
> Note: sendmmsg is not supported on MacOS, make sure you add -DXQC\_SUPPORT\_SENDMMSG\_BUILD=0 to turn off the feature
## Windows Release

```bash
Expand Down
Binary file removed docs/images/dingtalk_group.jpg
Binary file not shown.
Binary file added docs/images/dingtalk_group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 25780c3

Please sign in to comment.