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

DOC: Simple Implementation section suggestions #10

Closed
jsheunis opened this issue Sep 18, 2023 · 1 comment
Closed

DOC: Simple Implementation section suggestions #10

jsheunis opened this issue Sep 18, 2023 · 1 comment

Comments

@jsheunis
Copy link
Contributor

jsheunis commented Sep 18, 2023

This section is currently too minimal to bring users up to speed on what they should be doing to get started. The only text is "For example". What should a user do? Should they always first write a python script to get started? should they copy the sample script and update it to their own parameters? What exactly should be in place on the hardware level before they implement a script?

This section is also a good place to mention and link to the pseudo-device description, so that users can know that they don't necessarily need a hardware setup in order to start using pybci.

openjournals/joss-reviews#5706

@jsheunis jsheunis mentioned this issue Sep 18, 2023
@LMBooth
Copy link
Owner

LMBooth commented Oct 13, 2023

Excellent suggestion @jsheunis , I've amended the documentation to be more informative to the user. Thankyou for bringing this to my attention.

@LMBooth LMBooth closed this as completed Oct 13, 2023
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