Skip to content

Commit 59d3f83

Browse files
Update README.md
1 parent 247220d commit 59d3f83

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Now, every new measurement can be filtered (See examples 1,2):
1717
OUTPUT_TYPE new_filtered_value = my_filter.Update(new_value);
1818
```
1919

20-
The Z transform numerator & denominator coefficients can also be supplied and the library will automatically convert them to the filter weights:
20+
Besides, the Z transform numerator & denominator coefficients (from f.x. MATLAB) can be supplied instead and the library will automatically convert them to the filter weights:
2121
``` c++
2222
my_filter.SetCoefficientsFromZTransform(numerator,denominator);
2323
```
24-
The state can be cleared to reinitialize the filter:
24+
The filter can be cleared for easy reinitialziation:
2525
``` c++
2626
my_filter.ClearState();
2727
```
@@ -33,7 +33,9 @@ Finally although not recommended, it is possible to change the filter states:
3333

3434

3535
## Compilation
36-
This repository uses CMake. It is already configured for the [CMake Tools extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) and runs on the default generator.
36+
For usage of this library, check [installation](#Installation) chapter.
37+
38+
For development, this repository uses CMake. It is already configured for the [CMake Tools extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) and runs on the default generator.
3739

3840
## Documentation
3941
This repository uses doxygen. For Windows, run `doxygen Doxyfile`.

0 commit comments

Comments
 (0)