PointCloudLibrary / PointCloudLibrary/pcl

Docs for Prebuilt Binaries

Open
#4,308 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

effort: low good first issue kind: request kind: todo module: docs
Dominant language
C++
Stars
11.1k
Forks
4.7k
Avg merge
4d 10h
Merged PRs (30d)
6

Description

Hi,

I have installed PCL on Windows, and have discovered that PCL provides "Prebuilt Binaries" present at $(PCL_DIRECTORY)/bin/
apart from being an API library.
I found these binaries to be really helpful in my analysis of 3D models and have saved lot of my time.

However, I am not able to find what each of these "Prebuilt Binary" does. Right now I am going by guessing the name of each of the binary and looking at their command line help.

It would helpful, if there is a functional description of what each of the Binary is capable of doing.
This will help in being efficient while using PCL library such as deciding between writing a functionality on my own or using a prebuilt binary for the same.

P.S - There is some documentation present here - https://pcl.readthedocs.io/projects/tutorials/en/latest/walkthrough.html#binaries, but it is not the complete list

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing walkthrough section at https://pcl.readthedocs.io/projects/tutorials/en/latest/walkthrough.html#binaries and inspect the prebuilt binaries in $(PCL_DIRECTORY)/bin/ on Windows. Compare the listed tools with their command-line help, then document a functional description for the complete set so users can choose between an existing binary and implementing the functionality themselves.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.