diff --git a/README.md b/README.md index 28cdf8094..9dc67e522 100755 --- a/README.md +++ b/README.md @@ -48,25 +48,6 @@ There're lots of useful features in origin server, including transcoding, DVR, i The ST coroutine, HTTP API and tracable log cost SRS effective for maintainability. All wikis are writen in English and Chinese. -Why SRS? - -1. Completely rewriten HLS: Following m3u8/ts spec, and HLS support h.264+aac/mp3. -1. High efficient RTMP: Deliverying support 7k+ concurrency, vhost based, both origin and edge. -1. Embeded HTTP server: For HLS, api and HTTP flv/ts/mp3/aac streaming. -1. Variety inputs: RTMP, pull by ingest file or stream(HTTP/RTMP/RTSP), push by stream caster -RTSP/MPEGTS-over-UDP. -1. Popular internet delivery: RTMP/HDS for flash, HLS for mobile(IOS/IPad/MAC/Android), HTTP -flv/ts/mp3/aac streaming for user prefered, and MPEG-DASH. -1. Enhanced DVR: Segment/session/append plan, customer path and HTTP callback, to FLV/MP4 file. -1. Multiple features: Transcode, forward, ingest, http hooks, dvr, hls, rtsp, http streaming, -http raw api, refer, log, bandwith test and srs-librtmp. -1. Best maintainess: Simple arch over state-threads(coroutine), single thread, single process -and for linux/osx platform, common server x86-64/i386/arm/mips cpus, rich comments, strictly -follows RTMP/HLS/DASH/RTSP spec. -1. Easy to use: Both English and Chinese wiki, typically config files in trunk/conf, traceable -and session based log, linux service script and install script. -1. MIT license: Open source with product management and evolution. - > Remark: Although SRS is licenced under [MIT][LICENSE], but there are some depended libraries which are distributed using their own licenses, please read [License Mixing][LicenseMixing]. @@ -79,7 +60,8 @@ The `usage`, `wiki`, `changes`, `features`, `compare`, `release` and `performanc ### Usage Step 1: Get SRS. -Download slow? Please use [mirrors](#mirrors) for SRS. + +> Note: Repository too large? Please clone from [mirrors](#mirrors) instead. ``` git clone https://github.com/ossrs/srs && @@ -87,19 +69,22 @@ cd srs/trunk ``` Step 2: Build SRS. -Requires Centos6 32/64bits, others see Build([CN][v3_CN_Build],[EN][v3_EN_Build]). + +> Remark: Recommend Centos6 64bits, others read Build([CN][v3_CN_Build],[EN][v3_EN_Build]). + +> Note: For multiple cores such as 4CPUs, please use `./configure --jobs=4 && make --jobs=4` to speeed up. ``` ./configure && make ``` -Step 3: Start SRS +Step 3: Run SRS ``` ./objs/srs -c conf/srs.conf ``` -See also: +For other typical use scenarios, please read bellow wikis: * Usage: How to delivery RTMP?([CN][v1_CN_SampleRTMP], [EN][v1_EN_SampleRTMP]) * Usage: How to delivery RTMP Cluster?([CN][v3_CN_SampleRTMPCluster], [EN][v3_EN_SampleRTMPCluster]) * Usage: How to delivery HTTP FLV Live Streaming?([CN][v3_CN_SampleHttpFlv], [EN][v3_EN_SampleHttpFlv])