Skip to content

Commit fa0758e

Browse files
Address minor markdown issues [skip ci]
1 parent 415e73c commit fa0758e

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Reading and following these guidelines will help us make the contribution proces
66

77
## Quicklinks
88

9-
* [Getting Started](#getting-started)
10-
* [Issues](#issues)
11-
* [Pull Requests](#pull-requests)
12-
* [License](#license)
9+
- [Getting Started](#getting-started)
10+
- [Issues](#issues)
11+
- [Pull Requests](#pull-requests)
12+
- [License](#license)
1313

1414
## Getting Started
1515

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# TeiaCareVideoIO
2+
23
Welcome to TeiaCareVideoIO!
34

45
*TeiaCareVideoIO* is a C++ video encoder and decoder library.
56

67
![TeiaCareVideoIO](https://socialify.git.ci/TeiaCare/TeiaCareVideoIo/image?description=1&font=Raleway&name=1&pattern=Solid&theme=Auto)
78

8-
---
99

1010
## Getting Started
1111

12-
**Create a virtual environment**
12+
### Create a virtual environment
1313

1414
```bash
1515
python -m pip install --upgrade pip
@@ -30,7 +30,7 @@ pip install pre-commit==3.7.1
3030
pre-commit install
3131
```
3232

33-
**Setup Build Environment (Windows Only)**
33+
### Setup Build Environment (Windows Only)
3434

3535
When building from command line on Windows it is necessary to activate the Visual Studio Developer Command Prompt.
3636
Depending on the version of Visual Studio compiler and on its install location it is required to run *vcvars64.bat* script the set the development environment properly.
@@ -46,14 +46,14 @@ Examples:
4646
"C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
4747
```
4848

49-
**Dependencies Setup**
49+
### Dependencies Setup
5050

5151
This script must be executed in order to setup the conan packages (note that 3rd party libs are only required for unit tests, examples and benchmarks).
5252
```bash
5353
python scripts/conan/setup.py <Debug|Release|DebWithRelInfo> <COMPILER_NAME> <COMPILER_VERSION>
5454
```
5555

56-
**Configure, Build and Install**
56+
### Configure, Build and Install
5757

5858
This script configures, builds and installs the library.
5959
```bash
@@ -69,6 +69,7 @@ Examples are installed in $PWD/install/examples.
6969

7070

7171
## Unit Tests and Code Coverage
72+
7273
Unit tests execution requires video data generation. In order to generate such data it is required to run the following python script:
7374
```bash
7475
python3 scripts/tests/generate_test_data.py
@@ -131,6 +132,7 @@ python scripts/tools/run_cppcheck.py <Debug|Release|RelWithDebInfo>
131132
```
132133

133134
- [cpplint](https://github.com/cpplint/cpplint) [TODO: Review]
135+
134136
```bash
135137
# TODO: add python script.
136138
cpplint --counting=detailed $(find teiacare_video_io* -type f -name "*.hpp" -or -name "*.cpp")
@@ -204,6 +206,7 @@ Copyright © 2024 [TeiaCare](https://teiacare.com/)
204206

205207

206208
## Video Streaming Integration Test (RTSP)
209+
207210
```bash
208211
# Start mediamtx proxy stream
209212
docker run --network=host -e MTX_PROTOCOLS=tcp -p 8554:8554 bluenviron/mediamtx

0 commit comments

Comments
 (0)