Skip to content

Commit 97f2cfd

Browse files
committed
Fix README to reflect to latest changes regarding the directory structure.
1 parent 937f250 commit 97f2cfd

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,35 @@ functions.
66

77
## How to build
88

9-
The `rtp` package directory contains a standard Makefile. To build the package
10-
just run `gomake` and then `gomake install`. Use `gotest` to execute the tests
11-
check if the code works with the current Go installation on your system. It
12-
should PASS. On my system I currently use `6g version weekly.2011-12-14
13-
10879`. I usually update Go every two weeks or so and adapt the code if
14-
necessary.
9+
The _rtp_ sources use the GOPATH directory structure. To build, test, and run
10+
the software just add the main goRTP directory to GOPATH. For further
11+
information about this structure run `go help gopath` and follow the
12+
instructions. The _rtp_ package is below the package _net_ to make clear that
13+
_rtp_ is a network related package.
14+
15+
To build the package just run `go build net/rtp` and then `go install
16+
net/rtp`. To excecute the tests just run `go test net/rtp`. The tests check if
17+
the code works with the current Go installation on your system. It should
18+
PASS.
19+
20+
A demo program is available and is called _rtpmain_. Use `go build
21+
net/rtpmain` to build it. The command `go install net/rtpmain` installs it in
22+
the `bin` directory of the main directory.
1523

1624
## How to use
1725

1826
This is a pure RTP / RTCP stack and it does not contain any media processing,
1927
for example generating or packing the payload for audio or video codecs.
2028

21-
The directory `src/cmd/rtpmain` contains an example Go program that performs a
29+
The directory `src/net/rtpmain` contains an example Go program that performs a
2230
RTP some tests on _localhost_ that shows how to setup a RTP session, an
2331
output stream and how to send and receive RTP data and control events. Parts
2432
of this program are used in the package documentation.
2533

26-
The software is tagged as V1.0.0RC2 (IMHO) and should be ready to use for
27-
many RTP applications. Standard point-to-point RTP applications should not
28-
pose any problems. RTP multi-cast using IP multi-cast addresses is not
29-
supported. If somebody really requires IP multi-cast it could be added at the
30-
transport level.
34+
The software should be ready to use for many RTP applications. Standard
35+
point-to-point RTP applications should not pose any problems. RTP multi-cast
36+
using IP multi-cast addresses is not supported. If somebody really requires IP
37+
multi-cast it could be added at the transport level.
3138

3239
RTCP reporting works without support from application. The stack reports RTCP
3340
packets and if the stack created new input streams and an application may

0 commit comments

Comments
 (0)