Skip to content

Commit 7eb9430

Browse files
authored
[=] Update README.md, add install deps instructions, typo fixes and minor markdown style fixes (#456)
1 parent 9d3cb85 commit 7eb9430

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

README.md

+15-20
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,17 @@ XQUIC Library released by Alibaba is …
3838
#### Standardized Features
3939

4040
* All big features conforming with [RFC 9000](https://www.rfc-editor.org/rfc/rfc9000), [RFC9001](https://www.rfc-editor.org/rfc/rfc9001), [RFC9002](https://www.rfc-editor.org/rfc/rfc9002), [RFC9114](https://www.rfc-editor.org/rfc/rfc9114) and [RFC9204](https://www.rfc-editor.org/rfc/rfc9204), including the interface between QUIC and TLS, 0-RTT connection establishment, HTTP/3 and QPACK.
41-
4241
* ALPN Extension conforming with [RFC7301](https://www.rfc-editor.org/rfc/rfc7301)
4342

4443
#### Not Yet Standardized Features
4544

4645
* [Multipath QUIC](https://tools.ietf.org/html/draft-ietf-quic-multipath-04)
47-
4846
* [QUIC-LB](https://tools.ietf.org/html/draft-ietf-quic-load-balancers-13)
4947

5048
#### Library Features
5149

5250
* Pluggable congestion control: NewReno, Cubic, BBR and BBRv2, ...
53-
5451
* Pluggable cryptography, integration with BoringSSL and BabaSSL
55-
5652
* Cross-platform implementation, support Android, iOS, HarmonyOS, Linux, macOS and Windows(v1.2.0)
5753

5854
## Requirements
@@ -67,30 +63,29 @@ To run test cases, you need
6763

6864
## QuickStart Guide
6965

70-
XQUIC can be built with Tongsuo(BabaSSL) or BoringSSL.
66+
XQUIC can be built with BabaSSL(Tongsuo) or BoringSSL.
7167

7268
### Build with BoringSSL
7369

7470
```bash
71+
sudo apt-get install -y build-essential libevent-dev
72+
7573
# get XQUIC source code
76-
git clone https://github.com/alibaba/xquic.git
77-
cd xquic
74+
git clone https://github.com/alibaba/xquic.git; cd xquic
7875

7976
# get and build BoringSSL
80-
git clone https://github.com/google/boringssl.git ./third_party/boringssl
81-
cd ./third_party/boringssl
77+
git clone https://github.com/google/boringssl.git ./third_party/boringssl; cd ./third_party/boringssl
8278
mkdir -p build && cd build
8379
cmake -DBUILD_SHARED_LIBS=0 -DCMAKE_C_FLAGS="-fPIC" -DCMAKE_CXX_FLAGS="-fPIC" ..
84-
make ssl crypto
80+
make -j ssl crypto
8581
cd ..
8682
SSL_TYPE_STR="boringssl"
8783
SSL_PATH_STR="${PWD}"
8884
cd ../..
89-
## Note: if you don’t have golang in your environment, please install [golang](https://go.dev/doc/install) first.
9085

9186
# build XQUIC with BoringSSL
92-
# When build XQUIC with boringssl, /usr/local/babassl directory will be searched
93-
# as default. if boringssl is deployed in other directories, SSL_PATH could be
87+
# When build XQUIC with boringssl, by default XQUIC will use boringssl
88+
# in third_party. If boringssl is deployed in other directories, SSL_PATH could be
9489
# used to specify the search path of boringssl
9590
git submodule update --init --recursive
9691
mkdir -p build; cd build
@@ -108,23 +103,23 @@ make -j
108103
### Build with BabaSSL(Tongsuo)
109104

110105
```bash
106+
sudo apt-get install -y build-essential libevent-dev
107+
111108
# get XQUIC source code
112-
git clone https://github.com/alibaba/xquic.git
113-
cd xquic
109+
git clone https://github.com/alibaba/xquic.git; cd xquic
114110

115111
# get and build BabaSSL(Tongsuo)
116-
git clone -b 8.3-stable https://github.com/Tongsuo-Project/Tongsuo.git ./third_party/babassl
117-
cd ./third_party/babassl/
112+
git clone -b 8.3-stable https://github.com/Tongsuo-Project/Tongsuo.git ./third_party/babassl; cd ./third_party/babassl/
118113
./config --prefix=/usr/local/babassl
119114
make -j
120115
SSL_TYPE_STR="babassl"
121116
SSL_PATH_STR="${PWD}"
122117
cd -
123118

124119
# build XQUIC with BabaSSL
125-
# When build XQUIC with boringssl, /usr/local/babassl directory will be searched
126-
# as default. if boringssl is deployed in other directories, SSL_PATH could be
127-
# used to specify the search path of boringssl
120+
# When build XQUIC with babassl, /usr/local/babassl directory will be searched
121+
# as default. If babassl is deployed in other directories, SSL_PATH could be
122+
# used to specify the search path of babassl
128123
git submodule update --init --recursive
129124
mkdir -p build; cd build
130125
cmake -DGCOV=on -DCMAKE_BUILD_TYPE=Debug -DXQC_ENABLE_TESTING=1 -DXQC_SUPPORT_SENDMMSG_BUILD=1 -DXQC_ENABLE_EVENT_LOG=1 -DXQC_ENABLE_BBR2=1 -DXQC_ENABLE_RENO=1 -DSSL_TYPE=${SSL_TYPE_STR} -DSSL_PATH=${SSL_PATH_STR} ..

0 commit comments

Comments
 (0)