我在GitHub上有一个要提交给CRAN的R
软件包。到目前为止,该程序包已经包含了一个扩展的README.md文档,其中显示:
包核心功能执行的示例,
包演示执行的示例,
一些基准测试结果。
对于GitHub用户而言,我认为将它们放到README.md上比使用小插图更具吸引力,因为它在用户查看软件包的回购协议时会显示出来。
当我打算将程序包移至CRAN时,我想要的内容与小插图形式的README.md中的内容几乎相同。
问题:将README.md的近1-1副本制作成小插图,同时保留两者,更新GitHub repo以使其具有该小插图,然后将其提交给CRAN,这是一种正确的操作方式吗?或者:是否会造成重复,不应该发生? (那我应该如何进行?)
最佳答案
是的,我认为这并不少见。您
在GitHub上有一个README.md作为(源)软件包回购的'公开面孔'
想要小插图可能适合的包装摘要
甚至可能以打包网站或摘要结尾
并且相同的降价文字也可以在所有三种情况下使用。
无论如何,都没有反对它的规则。另外,如果您不知道,对于与包装有关的专门且专注的r-package-devel
邮件列表,这将是一个很好的问题。