Skip to content

Commit 4171592

Browse files
committed
Documentation updates
Formatting and link fixes
1 parent 2a12395 commit 4171592

File tree

2 files changed

+37
-24
lines changed

2 files changed

+37
-24
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
## RabbitMQ .NET Client [![Build status](https://ci.appveyor.com/api/projects/status/33srpo7owl1h3y4e?svg=true)](https://ci.appveyor.com/project/rabbitmq/rabbitmq-dotnet-client)
1+
## RabbitMQ .NET Client
2+
3+
* AppVeyor: [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/33srpo7owl1h3y4e?svg=true)](https://ci.appveyor.com/project/rabbitmq/rabbitmq-dotnet-client)
4+
* TravisCI: [![Travis CI Build Status](https://travis-ci.org/rabbitmq/rabbitmq-dotnet-client.svg?branch=master)](https://travis-ci.org/rabbitmq/rabbitmq-dotnet-client)
25

36
This repository contains source code of the [RabbitMQ .NET client](https://www.rabbitmq.com/dotnet.html).
47
The client is maintained by the [RabbitMQ team at VMware](https://github.com/rabbitmq/).
58

6-
## Dependency (Binaries and Nuget Artifact)
9+
10+
## Dependency (NuGet Artifact)
711

812
### Modern Versions
913

@@ -12,9 +16,7 @@ The client is [distributed via NuGet](https://www.nuget.org/packages/RabbitMQ.Cl
1216
### Legacy Versions
1317

1418
`3.6.x` and earlier releases were distributed [together with RabbitMQ server 3.6.x](https://github.com/rabbitmq/rabbitmq-server/releases/)
15-
as archives.
16-
17-
[Release archive up to 3.4.3](https://bintray.com/rabbitmq/archive/rabbitmq-dotnet-client) is available from Bintray.
19+
as archives. You can also install `3.6.x` versions via [NuGet](https://www.nuget.org/packages/RabbitMQ.Client/).
1820

1921

2022
## Tutorials and Documentation
@@ -37,18 +39,20 @@ For .NET Core users, 2.0 is the minimum supported version for `5.x` series.
3739

3840
`3.6.x` releases support Linux and MacOS on [Mono](https://www.mono-project.com/).
3941

42+
4043
## Change Log
4144

42-
See [/CHANGELOG.md](https://github.com/rabbitmq/rabbitmq-dotnet-client/blob/master/CHANGELOG.md).
45+
See [CHANGELOG.md](CHANGELOG.md).
46+
4347

4448
## Building from Source
4549

46-
Please see [How to Run Tests](./RUNNING_TESTS.md) and [Building .NET Core](./BUILD_DOTNET_CORE.md)
47-
for build process overview.
50+
Please see [How to Run Tests](RUNNING_TESTS.md) for the build and test process overview.
51+
4852

4953
## Contributing
5054

51-
See [Contributing](./CONTRIBUTING.md) and [How to Run Tests](./RUNNING_TESTS.md).
55+
See [Contributing](CONTRIBUTING.md) and [How to Run Tests](RUNNING_TESTS.md).
5256

5357

5458
## License

RUNNING_TESTS.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
## Overview
22

3-
.NET client's test suite assumes there's a RabbitMQ node listening on localhost:5672
3+
.NET client's test suite assumes there's a RabbitMQ node listening on `localhost:5672`
44
(the default settings). SSL tests require a broker listening on the default
55
SSL port. Connection recovery tests assume `rabbitmqctl` at `../rabbitmq-server/scripts/rabbitmqctl`
66
can control the running node: this is the case when all repositories are cloned using
77
the [umbrella repository](https://github.com/rabbitmq/rabbitmq-public-umbrella).
88

9-
It is possible to use [Visual Studio 2015 Community Edition](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx),
10-
.NET Core, and `dotnet.exe` in `PATH`, to build the client and run the test suite.
9+
It is possible to use Visual Studio Community Edition .NET Core, and
10+
`dotnet.exe` in `PATH`, to build the client and run the test suite.
11+
1112

1213
## Building
1314

@@ -27,39 +28,47 @@ This will complete the code AMQP 0-9-1 protocol code generation and build all pr
2728

2829
## Running Tests
2930

30-
Tests can be run from Visual Studio using [NUnit Test Adapter](https://visualstudiogallery.msdn.microsoft.com/6ab922d0-21c0-4f06-ab5f-4ecd1fe7175d).
31-
Note that it may take some time for the adapter to discover tests in the assemblies.
31+
Tests can be run from Visual Studio using the NUnit Test Adapter. Note that it
32+
may take some time for the adapter to discover tests in the assemblies.
3233

33-
The test suite assumes there's a RabbitMQ node running locally with all defaults, and the tests will need to be able to run commands against the [rabbitmqctl](https://www.rabbitmq.com/rabbitmqctl.8.html) tool for that node. Two options to accomplish this are:
34+
The test suite assumes there's a RabbitMQ node running locally with all
35+
defaults, and the tests will need to be able to run commands against the
36+
[`rabbitmqctl`](https://www.rabbitmq.com/rabbitmqctl.8.html) tool for that node.
37+
Two options to accomplish this are:
3438

3539
1. Team RabbitMQ uses [rabbitmq-public-umbrella](https://github.com/rabbitmq/rabbitmq-public-umbrella), which sets up a local RabbitMQ server [built from source](https://www.rabbitmq.com/build-server.html):
36-
```
40+
```
3741
git clone https://github.com/rabbitmq/rabbitmq-public-umbrella umbrella
3842
cd umbrella
3943
make co
4044
cd deps/rabbit
4145
make
4246
make run-broker
43-
```
47+
```
4448
4549
2. You can load a RabbitMQ node in a [docker](https://www.docker.com/) container. You will need to create an environment variable `RABBITMQ_RABBITMQCTL_PATH` and set it to `DOCKER:<container_name>` (for example `DOCKER:rabbitmq01`). This tells the unit tests to run the `rabbitmqctl` commands through docker, in the format `docker exec rabbitmq01 rabbitmqctl <args>`:
46-
```
50+
```
4751
docker run -d --hostname rabbitmq01 --name rabbitmq01 -p 15672:15672 -p 5672:5672 rabbitmq:3-management
48-
```
52+
```
4953
50-
Then, to run the tests on Windows use:
54+
Then, to run the tests on Windows use:
5155
56+
```
5257
run-test.bat
58+
```
5359
54-
On MacOS, Linux, BSD use:
60+
On MacOS, Linux, BSD use:
5561
62+
```
5663
run-test.sh
64+
```
5765
5866
Running individual tests and fixtures on Windows is trivial using the Visual Studio test runner.
5967
To run a specific tests fixture on MacOS or Linux, use the NUnit filter expressions to select the tests
6068
to be run:
6169
62-
dotnet test projects/Unit --filter "Name~TestAmqpUriParseFail"
63-
70+
```
71+
dotnet test projects/Unit --filter "Name~TestAmqpUriParseFail"
6472

65-
dotnet test projects/Unit --filter "FullyQualifiedName~RabbitMQ.Client.Unit.TestHeartbeats"
73+
dotnet test projects/Unit --filter "FullyQualifiedName~RabbitMQ.Client.Unit.TestHeartbeats"
74+
```

0 commit comments

Comments
 (0)