For #1537, #1282, sync with state-threads/srs

ossrs · Dec 25, 2019 · b672ad4 · b672ad4
1 parent 4e93ded
commit b672ad4
Showing 1 changed file with 17 additions and 3 deletions.
diff --git a/trunk/3rdparty/st-srs/README.md b/trunk/3rdparty/st-srs/README.md
@@ -1,10 +1,14 @@
-state-threads
-=============
+# state-threads
+
+![](http://ossrs.net:8000/gif/v1/sls.gif?site=github.com&path=/srs/srsst)
+[![](https://cloud.githubusercontent.com/assets/2777660/22814959/c51cbe72-ef92-11e6-81cc-32b657b285d5.png)](https://github.com/ossrs/srs/wiki/v1_CN_Contact#wechat)
 
 Fork from http://sourceforge.net/projects/state-threads, patched for [SRS](https://github.com/ossrs/srs/tree/2.0release).
 
 > See: https://github.com/ossrs/state-threads/blob/srs/README
 
+For original ST without any changes, checkout the [ST master branch](https://github.com/ossrs/state-threads/tree/master).
+
 ## Branch SRS
 
 The branch [srs](https://github.com/ossrs/state-threads/tree/srs) will be patched the following patches:
@@ -15,6 +19,7 @@ The branch [srs](https://github.com/ossrs/state-threads/tree/srs) will be patche
 - [x] [Refine TAB of code](https://github.com/ossrs/state-threads/compare/c2001d30ca58f55d72a6cc6b9b6c70391eaf14db...d2101b26988b0e0db0aabc53ddf452068c1e2cbc).
 - [x] Merge from [michaeltalyansky](https://github.com/michaeltalyansky/state-threads) and [xzh3836598](https://github.com/ossrs/state-threads/commit/9a17dec8f9c2814d93761665df7c5575a4d2d8a3), support [ARM](https://github.com/ossrs/state-threads/issues/1).
 - [x] Merge from [toffaletti](https://github.com/toffaletti/state-threads), support [valgrind](https://github.com/ossrs/state-threads/issues/2) for ST.
+- [x] Patch [st.osx10.14.build.patch](https://github.com/ossrs/srs/blob/2.0release/trunk/3rdparty/patches/6.st.osx10.14.build.patch), for osx 10.14 build.
 
 ## Docs
 
@@ -24,6 +29,13 @@ The branch [srs](https://github.com/ossrs/state-threads/tree/srs) will be patche
 
 ## Usage
 
+Get code:
+
+```
+git clone https://github.com/ossrs/state-threads.git st-1.9 &&
+git checkout -b srs origin/srs
+```
+
 For Linux:
 
 ```
@@ -53,9 +65,11 @@ make linux-debug EXTRA_CFLAGS="-DMD_HAVE_EPOLL -DMD_VALGRIND"
 For OSX, user must specifies the valgrind header files:
 
 ```
-make darwin-debug EXTRA_CFLAGS="-DMD_VALGRIND -I/usr/local/include"
+make darwin-debug EXTRA_CFLAGS="-DMD_HAVE_KQUEUE -DMD_VALGRIND -I/usr/local/include"
 ```
 
+> Remark: Latest OSX does not support ST, please use docker to run ST.
+
 ## Valgrind
 
 How to debug with gdb under valgrind, read [valgrind manual](http://valgrind.org/docs/manual/manual-core-adv.html#manual-core-adv.gdbserver-simple).