createReadMe.ps1

function Set-Readme {
    [CmdletBinding()]
    param (
        [String]    
        $TargetPath
    )

    # private helper function with extra param for receiving the root
    function Set-ReadMe-Helper {
        [CmdletBinding(DefaultParameterSetName = "StringPaths")]
        param (
            [Parameter(Position = 0, Mandatory, ParameterSetName = "StringPaths")]
            [String]
            $TargetPath,
            [Parameter(Position = 1, Mandatory, ParameterSetName = "StringPaths")]
            [String]
            $Root,
            [Parameter(ParameterSetName = "StringPaths")]
            [double]
            $Width
        )
        Push-Location $Root
        $PRECISION = 4
        $SCALE = 30
        
        $baseName = $TargetPath.Split('\')[-1]
        # Calculate distance from root to target directory
        $distance = $TargetPath.Split('\').Count - $Root.Split('\').Count + 1

        # base case 1: the target path is a file
        # provide a relative path to file in an img html tag
        if (Test-Path $TargetPath -PathType Leaf) {
            Write-Verbose -Message "TargetPath '$TargetPath' is a file"
            $relPath = Resolve-Path $TargetPath -Relative
            $relPath = $relPath.Replace('\', '/')
            # Check for common file extensions
            if($relPath -match '(README.md|\.gitignore|createReadMe\.ps1)'){
                return
            }
            if ($relPath -match '\.(png|jpg|jpeg|gif|bmp|svg)$') {
                return "[<img src='$relPath' width='${Width}vw' alt='$baseName'/>]($relPath)"
            }
            elseif ($relPath -match '\.(md|markdown|mdown|mkdn|mkd|mdwn|mdtxt|mdtext|text|txt)$') {
                return "[📃]($relPath '$baseName')"
            }
            elseif ($relPath -match '\.(mp4|avi|mov|webm)$') {
                return "[🎬]($relPath '$baseName')"
            }
            else {
                return "[📎]($relPath '$baseName')"
            }
            # Other relevant emojis for files:
            # 📁 📂 📅 📇 📈 📉 📊 📋 📌 📍 📎 📏 📐 📑 📒 📓 📔 📕 📖 📗 📘 📙 📚 📛 📜 📝 📞 📟 📠 📡 📢 📣

        }
    

        # base case 2: the target path is a directory with no contents
        # provide the name of the directory as a heading
        if ((Test-Path $TargetPath -PathType Container) -and (Get-ChildItem $TargetPath).Count -eq 0) {
            Write-Verbose -Message "TargetPath '$TargetPath' is a directory with no contents"
            return "#" * $distance + " " + $baseName
        }

        # recursive case: the target path is a directory with contents
        # provide the name of the directory as a heading
        Write-Verbose -Message "TargetPath '$TargetPath' is a directory with contents"
        # recursively call the function on each of the contents
        $fileContents = Get-ChildItem $TargetPath -File
        # Calculate width of each file by file count
        $fileCount = $fileContents.Count
        if($fileCount -gt 0){
            $fileWidth = [math]::Round( $SCALE * 100 / $fileCount, $PRECISION)
        }

        $dirContents = Get-ChildItem $TargetPath -Directory
        
        $returnString = "`n" + "#" * $distance + " " + $baseName + "`n"
        foreach ($file in $fileContents) {
            $returnString += (Set-ReadMe-Helper -TargetPath $file.FullName -Root $Root -Width $fileWidth) + " "
        }
        foreach ($dir in $dirContents) {
            $returnString += (Set-ReadMe-Helper $dir.FullName $Root)
        }
        return $returnString + "`n"
    }
    Set-ReadMe-Helper (Resolve-Path $TargetPath) (Resolve-Path $TargetPath)

}
# To run the above scripts, try the following command in the root directory:
#   Import-Module -FullyQualifiedName .\createReadMe.ps1 -Function Set-ReadMe -Force; Set-Readme -TargetPath . | Out-File README.md -Force