Add README.md documentation to all AliceVision modules#2087
Open
Add README.md documentation to all AliceVision modules#2087
Conversation
…ng documentation Co-authored-by: fabiencastan <153585+fabiencastan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add README.md to each alicevision module without existing documentation
Add README.md documentation to all AliceVision modules
Mar 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Each module under
src/aliceVisionpreviously lacked inline documentation. This PR adds aREADME.mdto every module that was missing one, following the style established bycamera/andfeature/.Features list
README.mdto 31 modules:calibration,cmdline,colorHarmonization,dataio,depthMap,featureEngine,fuseCut,gpu,graph,hdr,imageMasking,imageMatching,imageProcessing,lensCorrectionProfile,lightingEstimation,matchingImageCollection,mesh,mvsData,mvsUtils,panorama,photometricStereo,python,segmentation,sensorDB,sfmDataIO,sfmMvsUtils,sphereDetection,stl,system,utils,voctreeImplementation remarks
Each README covers:
Existing READMEs (
camera,feature,geometry,image,keyframe,linearProgramming,matching,multiview,numeric,robustEstimation,sfm,sfmData,track) were left unchanged.💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.