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

Recipe documentation #527

Open
mattwthompson opened this issue Apr 26, 2019 · 3 comments
Open

Recipe documentation #527

mattwthompson opened this issue Apr 26, 2019 · 3 comments

Comments

@mattwthompson
Copy link
Member

Describe the behavior you would like added to mBuild
I need to ask somebody to migrate a small repo into an mBuild recipe and the best documentation (barring me explaining it myself) is buried in a PR: #501 (comment)

Describe the solution you'd like
More thorough documentation, and probably an example of its use (i.e. https://github.com/ftiet/droplet-builder/blob/27fecdd81d060f8c51b0c3fb8bd06c4f6c2c15c9/setup.py#L48). A cookiecutter would be great too.

@rmatsum836
Copy link
Contributor

Since work on mBuild recipes is starting to ramp up, I'm going to take a stab at creating a cookie cutter for these.

@mikemhenry
Copy link
Member

Good idea! I've noticed that github now lets you mark repos when they are meant for being a template.

@CalCraven
Copy link
Contributor

I believe the cookie cutter repo was created and works great by @rmatsum836. I think we need further documentation in order to point users to this, potentially in the README and on our website.

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

No branches or pull requests

5 participants