Skip to content

Commit 65f6f3a

Browse files
committed
README: Minor fixes in text
1 parent 6ad6890 commit 65f6f3a

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</div>
77
</br>
88

9-
ipfixprobe is a high-performance flow exporter. It creates bidirectional flows from packet input and exports them to output interface. The ipfixprobe support vide variety of flow extenstion for application layer protocol information. The flow extension can be turned on with process plugins. We support TLS, QUIC, HTTP, DNS and many more. Just check our [documentation](https://ipfixprobe.cesnet.cz).
9+
The ipfixprobe is a high-performance flow exporter. It creates bidirectional flows from packet input and exports them to output interface. The ipfixprobe support vide variety of flow extenstion for application layer protocol information. The flow extension can be turned on with process plugins. We support TLS, QUIC, HTTP, DNS and many more. Just check our [documentation](https://ipfixprobe.cesnet.cz).
1010

1111
[![](https://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/CESNET/ipfixprobe/blob/master/LICENSE)
1212
[![](https://img.shields.io/badge/docs-ipfixprobe-blue.svg)](https://ipfixprobe.cesnet.cz)
@@ -105,7 +105,7 @@ sudo dnf install -y git wget curl net-tools gcc gcc-c++ \
105105

106106
---
107107

108-
### ⚙️ Project Setup with CMake
108+
### ⚙️ Project build with CMake
109109

110110
This project uses the standard CMake build system. Example setup:
111111

@@ -116,13 +116,15 @@ mkdir build && cd build
116116
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
117117
```
118118

119-
To view available build options:
119+
#### 🔧 Notable CMake Build Options
120+
121+
Run the command to view all available build options:
120122

121123
```bash
122124
cmake -LAH
123125
```
124126

125-
### 🔧 Notable CMake Build Options
127+
The most notable options are:
126128

127129
| Option | Description |
128130
|--------------------------------|--------------------------------------------------------------------------|
@@ -137,7 +139,7 @@ cmake -LAH
137139

138140
---
139141

140-
### 🛠️ Build from Source
142+
#### 🛠️ Build from Source
141143

142144
Once the CMake project is configured, build the project using:
143145

@@ -159,7 +161,7 @@ make install
159161

160162
---
161163

162-
### 📦 Build RPM Packages
164+
#### 📦 Build RPM Packages
163165

164166
RPM packages are created automatically based on the enabled CMake options.
165167

@@ -273,7 +275,7 @@ The pipeline directory provides statistics for all worker queues. Each queue is
273275
274276
## 📥 Input / Output of the flow exporter
275277
276-
The availability of input and output types depends on the installed packages or enabled build options (see Project Setup with CMake).
278+
The availability of input and output types depends on the installed packages or enabled build options (see section of README Project Setup with CMake).
277279
By default, installing the `ipfixprobe` package enables standard raw socket output.
278280
279281
To enable additional input capabilities, install the corresponding input plugin packages:
@@ -290,11 +292,11 @@ For more information, visit the [input plugin documentation](https://ipfixprobe.
290292
Similarly as in input, the output availability also depends on the installed packages.
291293
By default, installed the `ipfixprobe` package enables standard `ipfix` and `text` output.
292294
293-
To exanble [NEMEA system](https://nemea.liberouter.org) output, you should install `ipfixprobe-nemea` instead of ipfixprobe
295+
To add [NEMEA system](https://nemea.liberouter.org) output capability, you should install `ipfixprobe-nemea` instead of ipfixprobe
294296
295297
See `ipfixprobe -h output` for more information and complete list of output plugins and their parameters.
296298
297-
LZ4 compression:
299+
#### LZ4 compression:
298300
ipfix plugin supports LZ4 compression algorithm over tcp. See plugin's help for more information.
299301
300302

0 commit comments

Comments
 (0)