pulp-platform/bender

How to create a package?

hydroid7 opened this issue · 2 comments

Hi there,
while implementing siphash for my master thesis, I discovered the PULP platform. I'd like to create a bender package from it to allow other users to use my code.
Since there is no documentation on how to create a package, I'd want to kindly ask you on some help how to create one from my code?

https://github.com/hydroid7/siphash

Thank you in advance.
Best Regards

In general, to create a package, all you will have to do is add a Bender.yml file to your repository with the format described here. There is no central repository or collection for bender packages; we also manage them using the git repositories in the PULP platform.

Regarding your bender.yml file, AFAIK, you should capitalize the B in the file name, the rest should work. Other than that, as you do not have any dependencies, I don't think declaring the checkout_dir is necessary (this indicates where bender should place dependencies if this is your top-level package). Feel free to check out more complex examples like AXI.

Thank you for the fast reply! :) Indeed renaming the file helped. The example is also really helpful.
I opened #128 for improving the error message.