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

Point to a minial example repository in the author guideline doc #45

Open
htwangtw opened this issue Dec 11, 2023 · 4 comments · May be fixed by #48
Open

Point to a minial example repository in the author guideline doc #45

htwangtw opened this issue Dec 11, 2023 · 4 comments · May be fixed by #48

Comments

@htwangtw
Copy link

This is an insight from discussion with @mirhnius at Brianhack Montreal 2023. (Niushia please feel free to chime in.)

For people who has never used binder, the first hurdle is how to make their repository work with binder. Having an minimal example, or point readers to an existing preprint with a simple set up might be a good idea.

@htwangtw
Copy link
Author

https://github.com/pbellec/editorial_parcellation/

or highlight https://github.com/neurolibre/template
I didn't realise a template exists

@mirhnius
Copy link

Perhaps you could make it stand out under "quick start" or some other attention-grabbing heading.

@htwangtw
Copy link
Author

that's a good idea! Do you want to start a PR?
Feel free to open issue if you spot more errors in the doc

@htwangtw
Copy link
Author

I think this can be combined with neurolibre/neurolibre#50
So we have a minimal example plus using roboneuro as a quick start

@htwangtw htwangtw linked a pull request Dec 12, 2023 that will close this issue
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

Successfully merging a pull request may close this issue.

2 participants