Skip to content

Commit

Permalink
doc: refactor github markdown url to relative url; add dockerhub imag…
Browse files Browse the repository at this point in the history
…e badges and add teamcity url to badge
  • Loading branch information
RedLeader962 committed Jan 10, 2024
1 parent bdcf9d1 commit 6de0d75
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
- [ ] I have commented hard-to-understand code
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] All tests pass locally with my changes
(Check [contributing_instructions.md](https://github.com/norlab-ulaval/libnabo/tree/develop/doc/contributing/contributing_instructions.md) for local testing procedure using _libpointmatcher-build-system_)
(Check [contributing_instructions.md](/doc/contributing/contributing_instructions.md) for local testing procedure using _libpointmatcher-build-system_)

### PR creation related

Expand All @@ -34,6 +34,6 @@
- [ ] I have included a quick summary of the changes
- [ ] I have indicated the related issue's id with `# <issue-id>` if changes are of type `fix`
- [ ] I have included a high-level list of changes and their corresponding types
(See [commit_msg_reference.md](https://github.com/norlab-ulaval/libnabo/tree/develop/doc/contributing/commit_msg_reference.md) for details)
(See [commit_msg_reference.md](/doc/contributing/commit_msg_reference.md) for details)

---
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,23 @@

![banner](doc/images/banner_light.jpeg)

[//]: # ( ==== Description =========================================== )
[//]: # ( ==== Description ====================================================================== )
**_libpointmatcher_ is a modular library implementing the Iterative Closest Point (ICP) algorithm<br>
for aligning point clouds. It has applications in robotics and computer vision.**
<br>
The library is written in C++ for effeciency
with [bindings in Python](doc/index.md#python-).
The library is written in C++ for efficiency with [bindings in Python](doc/index.md#python-).
<br>
<br>

[//]: # (====GitHub badges========================================================================)
[//]: # (====Badges===============================================================================)

<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/norlab-ulaval/libpointmatcher">
<img alt="GitHub forks" src="https://img.shields.io/github/forks/norlab-ulaval/libpointmatcher">
<img alt="GitHub License" src="https://img.shields.io/github/license/norlab-ulaval/libpointmatcher">
<img alt="GitHub release (with filter)" src="https://img.shields.io/github/v/release/norlab-ulaval/libpointmatcher">
<img src="https://img.shields.io/static/v1?label=JetBrains TeamCity&message=CI/CD&color=green?style=plastic&logo=teamcity" />
<a href="http://132.203.26.125:8111"><img src="https://img.shields.io/static/v1?label=JetBrains TeamCity&message=CI/CD&color=green?style=plastic&logo=teamcity" /></a>
<a href="https://hub.docker.com/repository/docker/norlabulaval/libpointmatcher/"> <img alt="Docker Image Version (latest semver)" src="https://img.shields.io/docker/v/norlabulaval/libpointmatcher?logo=docker&label=libpointmatcher"> </a>

<br>
<br>

Expand All @@ -37,11 +38,12 @@ with [bindings in Python](doc/index.md#python-).
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
<a href="http://jslee02.github.io/awesome-robotics-libraries/#3d-mapping">Robotics Libraries</a>
</sup>

<br>
<br>
<hr style="color:lightgray;background-color:lightgray">
</div>



[//]: # (====Supported OS and aarch===============================================================)

### Supported OS And Architecture
Expand Down
2 changes: 1 addition & 1 deletion build_system/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
See [contributing_instructions.md](https://github.com/norlab-ulaval/libnabo/tree/develop/doc/contributing/contributing_instructions.md)
See [contributing_instructions.md](/doc/contributing/contributing_instructions.md)
for instructions related to bug reporting, code contribution and for setting up the `libpointmatcher-build-system` on your workstation to speed up your local development workflow.

0 comments on commit 6de0d75

Please sign in to comment.