Skip to content

Commit c809932

Browse files
committed
[doc] markdown linting
1 parent aa7b7f1 commit c809932

File tree

3 files changed

+42
-52
lines changed

3 files changed

+42
-52
lines changed

CHANGES.md

Lines changed: 36 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -41,95 +41,90 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4141
- Using the new TBB oneAPI interface, this breaks compatibility with previous versions of TBB [PR](https://github.com/alicevision/CCTag/pull/200)
4242

4343
### Fixed
44+
4445
- fix gcc11 ordered pointer comparison [PR](https://github.com/alicevision/CCTag/pull/191)
4546
- fix handling of `BUILD_SHARED_LIBS` option [PR](https://github.com/alicevision/CCTag/pull/201)
4647

4748
## [1.0.2] - 2022-07-14
4849

4950
### Added
51+
5052
- Added documentation for conan [PR](https://github.com/alicevision/CCTag/pull/183)
5153

5254
### Fixed
55+
5356
- Fixed potential out of bound in debug mode [PR](https://github.com/alicevision/CCTag/pull/180)
5457

5558
## [1.0.1] - 2021-10-08
5659

5760
### Changed
5861

59-
- Renamed the marker files to be 0-based [PR](https://github.com/alicevision/CCTag/pull/165)
62+
- Renamed the marker files to be 0-based [PR](https://github.com/alicevision/CCTag/pull/165)
6063

6164
### Fixed
6265

6366
- Fixed missing math module for boost [PR](https://github.com/alicevision/CCTag/pull/168)
6467
- Fixed compilation errors for newer version of boost on windows [PR](https://github.com/alicevision/CCTag/pull/166)
6568
- Removed old legacy defines for cuda and boost no more needed since the switch to c++14 [PR](https://github.com/alicevision/CCTag/pull/174)
6669

67-
6870
## [1.0.0] - 2021-06-24
6971

70-
- Support for OpenCV 3.4.9 [PR](https://github.com/alicevision/CCTag/pull/121)
71-
- Switch to C++14 standard [PR](https://github.com/alicevision/CCTag/pull/155)
72-
72+
- Support for OpenCV 3.4.9 [PR](https://github.com/alicevision/CCTag/pull/121)
73+
- Switch to C++14 standard [PR](https://github.com/alicevision/CCTag/pull/155)
7374

7475
## 2019
7576

76-
- Remove Cuda Cub dependency [PR](https://github.com/alicevision/CCTag/pull/110)
77-
- Bug fix: out of range image access during identification [PR](https://github.com/alicevision/CCTag/pull/117)
78-
- Bug fix on big markers (multi-resolution detection) [PR](https://github.com/alicevision/CCTag/pull/116)
79-
- Bug fix: avoid access to empty vector during vote [PR](https://github.com/alicevision/CCTag/pull/115)
80-
- CMake: export all symbols when building shared libs on Windows [PR](https://github.com/alicevision/CCTag/pull/112)
81-
- CMake: Improve management of CUDA Compute Capabilities flags [PR](https://github.com/alicevision/CCTag/pull/109)
82-
- Compatibility with Opencv 4 [PR](https://github.com/alicevision/CCTag/pull/104)
83-
77+
- Remove Cuda Cub dependency [PR](https://github.com/alicevision/CCTag/pull/110)
78+
- Bug fix: out of range image access during identification [PR](https://github.com/alicevision/CCTag/pull/117)
79+
- Bug fix on big markers (multi-resolution detection) [PR](https://github.com/alicevision/CCTag/pull/116)
80+
- Bug fix: avoid access to empty vector during vote [PR](https://github.com/alicevision/CCTag/pull/115)
81+
- CMake: export all symbols when building shared libs on Windows [PR](https://github.com/alicevision/CCTag/pull/112)
82+
- CMake: Improve management of CUDA Compute Capabilities flags [PR](https://github.com/alicevision/CCTag/pull/109)
83+
- Compatibility with Opencv 4 [PR](https://github.com/alicevision/CCTag/pull/104)
8484

8585
## 2018
8686

87-
- First Windows version (CPU only) [PR](https://github.com/alicevision/CCTag/pull/78)
88-
- Docker: add support for docker [PR](https://github.com/alicevision/CCTag/pull/84)
89-
- Improvements for ellipse fitting
87+
- First Windows version (CPU only) [PR](https://github.com/alicevision/CCTag/pull/78)
88+
- Docker: add support for docker [PR](https://github.com/alicevision/CCTag/pull/84)
89+
- Improvements for ellipse fitting
9090
[PR](https://github.com/alicevision/CCTag/pull/66)
91-
- Modernizing code to C++11
91+
- Modernizing code to C++11
9292
[PR](https://github.com/alicevision/CCTag/pull/64)
9393

94-
9594
## 2017
9695

97-
- Use Thrust for cuda >= 8
96+
- Use Thrust for cuda >= 8
9897
[PR](https://github.com/alicevision/CCTag/pull/62)
99-
- Minor code cleaning
98+
- Minor code cleaning
10099
[PR](https://github.com/alicevision/CCTag/pull/61)
101-
- Add limit to edgepoint d-to-h transfer
100+
- Add limit to edgepoint d-to-h transfer
102101
[PR](https://github.com/alicevision/CCTag/pull/53)
103-
- Bug fix in NearbyPoint
102+
- Bug fix in NearbyPoint
104103
[PR](https://github.com/alicevision/CCTag/pull/46)
105104

106-
107105
## 2016
108106

109-
- Switch to modern version of CMake [PR](https://github.com/alicevision/CCTag/pull/40)
110-
- CVPR Publication https://hal.archives-ouvertes.fr/hal-01420665/document
111-
- Application: Show detected markers in video and live mode
107+
- Switch to modern version of CMake [PR](https://github.com/alicevision/CCTag/pull/40)
108+
- CVPR Publication <https://hal.archives-ouvertes.fr/hal-01420665/document>
109+
- Application: Show detected markers in video and live mode
112110
[PR](https://github.com/alicevision/CCTag/pull/33)
113-
- Allow to extract CCTags from multiple images in parallel with multiple cuda streams
111+
- Allow to extract CCTags from multiple images in parallel with multiple cuda streams
114112
[PR](https://github.com/alicevision/CCTag/pull/32)
115113
[PR](https://github.com/alicevision/CCTag/pull/31)
116-
- Continuous integration on Travis [PR](https://github.com/alicevision/CCTag/pull/27)
117-
- Remove Blas/Lapack/Optpp dependencies
118-
- Remove Ceres dependency
119-
- GPU implementation
120-
114+
- Continuous integration on Travis [PR](https://github.com/alicevision/CCTag/pull/27)
115+
- Remove Blas/Lapack/Optpp dependencies
116+
- Remove Ceres dependency
117+
- GPU implementation
121118

122119
## 2015
123120

124-
- First open-source release
125-
- CPU Optimizations
126-
- Expose critical parameters
127-
- CMake build system
128-
121+
- First open-source release
122+
- CPU Optimizations
123+
- Expose critical parameters
124+
- CMake build system
129125

130126
## 2014
131127

132-
- Thesis Defence by Lilian Calvet under the direction of Vincent Charvillat and Pierre Gurdjos
133-
"Three-dimensional reconstruction methods integrating cyclic points: application to camera tracking" (http://www.theses.fr/2014INPT0002)
134-
- CCTag detection on CPU
135-
128+
- Thesis Defence by Lilian Calvet under the direction of Vincent Charvillat and Pierre Gurdjos
129+
"Three-dimensional reconstruction methods integrating cyclic points: application to camera tracking" (<http://www.theses.fr/2014INPT0002>)
130+
- CCTag detection on CPU

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
5555
## Enforcement
5656

5757
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team privately at [email protected]. All
58+
reported by contacting the project team privately at <[email protected]>. All
5959
complaints will be reviewed and investigated and will result in a response that
6060
is deemed necessary and appropriate to the circumstances. The project team is
6161
obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -68,7 +68,6 @@ members of the project's leadership.
6868
## Attribution
6969

7070
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct/>
7272

7373
[homepage]: https://www.contributor-covenant.org
74-

CONTRIBUTING.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
1-
Contributing to CCTag
2-
===========================
1+
# Contributing to CCTag
32

43
CCTag relies on a friendly and community-driven effort to create an open source photogrammetry solution.
54
In order to foster a friendly atmosphere where technical collaboration can flourish,
65
we recommend you to read the [code of conduct](CODE_OF_CONDUCT.md).
76

8-
9-
Contributing Workflow
10-
---------------------
7+
## Contributing Workflow
118

129
The contributing workflow relies on [Github Pull Requests](https://help.github.com/articles/using-pull-requests/).
1310

14-
1. If it is an important change, we recommend you to discuss it on the mailing-list before starting implementation.
11+
1. If it is an important change, we recommend you to discuss it on the mailing-list before starting implementation.
1512
This ensure that the development is aligned with other
16-
developpements already started and will be efficiently integrated.
13+
development already started and will be efficiently integrated.
1714

1815
2. Create the corresponding issues.
1916

@@ -32,4 +29,3 @@ congratulate the author, etc. using the github comments.
3229
will merge your fixes into the "develop" branch.
3330

3431
8. If not already the case, your name will be added to the [contributors list](CONTRIBUTORS.md).
35-

0 commit comments

Comments
 (0)