question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

README not copied when building the library

See original GitHub issue

The 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:open
  • Created 5 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
NetanelBasalcommented, Apr 2, 2018

Yes, it’s nice to have.

0reactions
caroso1222commented, Apr 2, 2018

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 copy LICENSE as well (if applicable)? I’ve seen it in many node packages within node_modules.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found