New package: BcubeVTK v0.1.0

[JuliaRegistrator]

• Registering package: BcubeVTK
• Repository: https://github.com/bcube-project/BcubeVTK.jl
• Created by: @bmxam
• Version: v0.1.0
• Commit: 22e301c6f762e060a9c9c6319f060bad39b338b2
• Reviewed by: @bmxam
• Reference: Julia Registrator bcube-project/BcubeVTK.jl#6 (comment)
• Description: Implementation of Bcube IO interface for VTK format

[github-actions]

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines are all met! ✅

Your new package registration met all of the guidelines for auto-merging and is scheduled to be merged when the mandatory waiting period (3 days) has elapsed.

3. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

[goerz]

Thank you for submitting your package! Could you add a little bit of documentation before registering? At the very least, in addition to the description that's already there, that would be a small usage example in the README. An important part of packages in General is that any potential user can figure out what the package is about and how to get started with using it. That is really difficult when there is no documentation.

In the longer term, I definitely recommend setting up a Documenter-based documentation. Before a v1.0 release, or for smaller packages that can be effectively described entirely with their README, that's not a requirement, though.

[bmxam]

Hi Michael,

I agree. I will update the README with more info and a short example. However, I won't push anything before monday (but anyway I guess the PR is blocked until I push something).

Just for your information, this is actually a "plugin" for the main package Bcube.jl who is instrumented with Documenter & Cie.

[goerz]

I won't push anything before monday (but anyway I guess the PR is blocked until I push something.

Yes, that's right. No rush!

Just for your information, this is actually a "plugin" for the main package Bcube.jl who is instrumented with Documenter & Cie.

Sometimes it's good enough to have a brief README with just a paragraph that points people to the documentation of the main project. The only point is that looking at the README, someone should have some idea of the context and if/how it can be used.

[noblock]