Skip to content

Commit 3ee8fa8

Browse files
17twentyedenhill
authored andcommitted
Fixup markdown and rename to readme.md (confluentinc#22)
Just general tidying, it's good to stick with markdown throughout.
1 parent 8afb660 commit 3ee8fa8

File tree

1 file changed

+28
-30
lines changed

1 file changed

+28
-30
lines changed
Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,50 @@
1-
Information for confluent-kafka-go developers
2-
=============================================
3-
1+
# Information for confluent-kafka-go developers
42

53
Whenever librdkafka error codes are updated make sure to run generate before building:
64

7-
$ (cd go_rdkafka_generr && go install) && go generate
8-
$ go build
9-
10-
5+
```
6+
$ (cd go_rdkafka_generr && go install) && go generate
7+
$ go build
8+
```
119

1210

1311

14-
Testing
15-
=======
1612

13+
## Testing
1714

1815
Some of the tests included in this directory, the benchmark and integration tests in particular,
1916
require an existing Kafka cluster and a testconf.json configuration file to
2017
provide tests with bootstrap brokers, topic name, etc.
2118

2219
The format of testconf.json is a JSON object:
2320
```
24-
{
25-
"Brokers": "<bootstrap-brokers>",
26-
"Topic": "<test-topic-name>"
27-
}
21+
{
22+
"Brokers": "<bootstrap-brokers>",
23+
"Topic": "<test-topic-name>"
24+
}
2825
```
2926

3027
See testconf-example.json for an example and full set of available options.
3128

3229

3330
To run unit-tests:
34-
35-
$ go test
36-
31+
```
32+
$ go test
33+
```
3734

3835
To run benchmark tests:
39-
40-
$ go test -bench .
36+
```
37+
$ go test -bench .
38+
```
4139

4240
For the code coverage:
41+
```
42+
$ go test -coverprofile=coverage.out -bench=.
43+
$ go tool cover -func=coverage.out
44+
```
4345

44-
$ go test -coverprofile=coverage.out -bench=.
45-
$ go tool cover -func=coverage.out
46-
46+
## Build tags (static linking)
4747

48-
Build tags (static linking)
49-
===========================
5048

5149
Different build types are supported through Go build tags (`-tags ..`),
5250
these tags should be specified on the **application** build command.
@@ -58,14 +56,14 @@ these tags should be specified on the **application** build command.
5856

5957

6058

61-
Generate HTML documentation
62-
===========================
59+
## Generating HTML documentation
6360

6461
To generate one-page HTML documentation run the mk/doc-gen.py script from the
6562
top-level directory. This script requires the beautifulsoup4 Python package.
6663

67-
$ source .../your/virtualenv/bin/activate
68-
$ pip install beautifulsoup4
69-
..
70-
$ mk/doc-gen.py > kafka.html
71-
64+
```
65+
$ source .../your/virtualenv/bin/activate
66+
$ pip install beautifulsoup4
67+
...
68+
$ mk/doc-gen.py > kafka.html
69+
```

0 commit comments

Comments
 (0)