README not copied when building the library
See original GitHub issueThe README.md
must be copied over to /dist
, otherwise the npm registry page will show an empty description. This is bad as the package won’t properly appear in searches.
Issue Analytics
- State:
- Created 5 years ago
- Comments:7 (7 by maintainers)
Top Results From Across the Web
Copy README and LICENSE if package.json not in root folder
A reasonable workaround is to just use symlinks from the README.md and LICENSE in the library directory to the root of the repository....
Read more >c# - Referenced library isn't copied - Stack Overflow
The compiler does not copy references that are only used in XAML. But if you use them in code, they are copied. This...
Read more >Library includes are not copied properly at compile
Hi all, I have been compiling a library and made it ROS compatible - and ... that the includes are not copied to...
Read more >Restricting the open source by adding a statement in README
My open source project is released under Apache2 License. I want people to use the library under Apache2 however I don't want people...
Read more >3 Common Tasks — The Yocto Project ® 4.1.999 documentation
Not only does this make sure the file is used only when building for machine “one” ... Tests if a README file exists...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Yes, it’s nice to have.
Yeah, definitely. I’ll create a
gulp.task('copy:readme')
to copy over that file. I was wondering, do you think we’ll need to copyLICENSE
as well (if applicable)? I’ve seen it in many node packages within node_modules.