• I've read and understood the CONTRIBUTING guidelines and have done my best effort to follow.

Report

What did you do?

Run pod install to install a local podspec whose sources contain multiple README.md files in various subdirectories.

What did you expect to happen?

The README.md files should be listed in Pods.xcodeproj to facilitate reading in consumer projects/workspaces, similar to the repo browsing experience on GitHub/GitLab/Bitbucket, where any README.md present in the currently browsing directory is rendered.

What happened instead?

README.md files from subdirectories are not included; only the one from the pod's source root, as mentioned in https://github.com/CocoaPods/CocoaPods/issues/2260.

I think it'd be best to just include any README.mds encountered as part of the xcodeproj generation. Some things I considered/tried:

• I tried preserve_paths but that didn't bring them into the project, just leaves them on disk.
• I thought a workaround might be to include README.mds as source files and somehow define Xcode build rules to ignore them, but that's really hacky and maybe not even possible.
• Adding a new declarator akin to preserve_paths, which would also add declared files to Pods.xcodeproj without any targets selected, could be useful, but would increase surface area for a really niche solution.

Thanks for your consideration! 👋🏻

CocoaPods Environment

Stack

   CocoaPods : 1.6.1
        Ruby : ruby 2.5.5p157 (2019-03-15 revision 67260) [x86_64-darwin18]
    RubyGems : 2.7.6.2
        Host : Mac OS X 10.14.4 (18E226)
       Xcode : 10.2 (10E125)
         Git : git version 2.20.1 (Apple Git-117)
Ruby lib dir : /Users/amcknight/.rbenv/versions/2.5.5/lib
Repositories : master - https://github.com/CocoaPods/Specs.git @ ef61253719174aaf39a8394ee9518acb63bf4012

Installation Source

Executable Path: /Users/amcknight/.rbenv/versions/2.5.5/bin/pod

Plugins

cocoapods-deintegrate : 1.0.4
cocoapods-plugins     : 1.0.0
cocoapods-search      : 1.0.0
cocoapods-stats       : 1.1.0
cocoapods-trunk       : 1.3.1
cocoapods-try         : 1.1.0

Podfile

platform :ios, '9.0'
source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!

target 'Swiftilities_Example' do
  pod 'Swiftilities', :path => '../'
end

target 'Swiftilities_Tests' do
  pod 'Swiftilities', :path => '../'
end