search

jothepro / doxygen-awesome-css

Custom CSS theme for doxygen html-documentation with lots of customization parameters.
https://jothepro.github.io/doxygen-awesome-css/
MIT License
956 stars 108 forks source link

Add support for install in the npm/xpm ecosystem #114

Closed ilg-ul closed 1 year ago

ilg-ul commented 1 year ago

As discussed in https://github.com/jothepro/doxygen-awesome-css/discussions/113, here is a proposal with the files required to identify the project as a npm/xpm package.

I also added a proposal to update the README with install instructions. Use it as a starting point and feel free to further edit it.

As an example I used version 2.2.1, but you probably should bump it to 2.3.0 when publishing your next release, since, according to semver rules, this is not a bug fix but can be considered a new feature.

For the beginning the users can install the package from the explicit GitHub URL (as documented in the README), and later, when you decide to publish the package on npmjs.com, to update the README.

ilg-ul commented 1 year ago

@jothepro, any comments on this PR?

ilg-ul commented 1 year ago

I think I fixed most issues, but the request to capitalise NPM seems to block the PR.

Please review and let me know if you have further suggestions.

ilg-ul commented 1 year ago

Thank you for approving it!

For now I'll probably continue to use my fork and deprecate it when you decide to publish your package on npmjs.com.