Pub-dev: Customize the Installing tab
It would be useful to be able to add custom instructions to the auto-generated text in the "Installing" tab, or to replace the contents completely.
Goal: provide instructions on how to install pre-compiled native libraries (for a package making use of FFI)
vaind
All 3 comments
Yes, we've discussed rendering INSTALL.md as the installation tab. I think something like this would be useful.
jonasfj
on 31 Oct 2019
We also discussed install.md in https://github.com/dart-lang/pub-dev/issues/2125.
jonasfj
on 8 Nov 2019
As briefly discussed in https://github.com/dart-lang/pub-dev/issues/3008 another option is to remove the "installation" instructions completely.
Arguments for removal is that if installation instructions are important to your package, it's probably best to show them at the top of your README.md as users are unlikely to see them otherwise.
We could probably look at analytics to see if anyone is opening the "installation" tab.
jonasfj
on 8 Nov 2019
Related issues
brianegan
路
4Comments
zoechi
路
3Comments
erickzanardo
路
5Comments
jonataslaw
路
4Comments
basilex
路
3Comments
Most helpful comment
As briefly discussed in https://github.com/dart-lang/pub-dev/issues/3008 another option is to remove the "installation" instructions completely.
Arguments for removal is that if installation instructions are important to your package, it's probably best to show them at the top of your
README.mdas users are unlikely to see them otherwise.We could probably look at analytics to see if anyone is opening the "installation" tab.