Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a wiki for documenting how to install XS modules #141

Open
hakonhagland opened this issue Oct 10, 2023 · 2 comments
Open

Create a wiki for documenting how to install XS modules #141

hakonhagland opened this issue Oct 10, 2023 · 2 comments

Comments

@hakonhagland
Copy link

Continuing the discussion from #139 (comment)

The suggestion is to use GitHub wikis to document how to install XS modules with strawberry perl. For example a main document "Installing-XS-modules.md" with links to sub documents for specific modules, like "Image-Magick.md". See #139 for an example.

As I understand, there might also be some drawbacks of using the wiki instead hosting the documentation in the main repository, see for example https://stackoverflow.com/q/10642928/2173773

@shawnlaffan
Copy link
Contributor

Documenting the build of XS modules is a good idea. Gtk modules also come to mind.

Wikis do have issues, but are probably a good way to reduce churn in the git history during drafting. The final version can then the shifted across to the main repo. Although one can also force push a PR as changes are made so maybe it's not such an problem.

@shawnlaffan
Copy link
Contributor

One thing to keep in mind is that, unless we exclude them, the files will end up on metacpan as part of the Perl::Dist::Strawberry dist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants