Update README.md with useful commands and tips

open-ephys / bonsai-onix1-docs

Documentation for the OpenEphys.Onix1 Bonsai package

https://open-ephys.github.io/bonsai-onix1-docs/

Creative Commons Attribution Share Alike 4.0 International

0 stars 2 forks source link

Update README.md with useful commands and tips #14

Closed cjsha closed 2 months ago

cjsha commented 2 months ago

The first step to making these docs easy for others to develop
Update submodule pointer to more recent commit

I request review from Brandon particularly in case I missed anything. I request review from Jon because he has yet to build these docs. These instructions must be sufficient to enable him to do that or they need to be amended.

cjsha commented 2 months ago

Jon made a comment to me: use triple back ticks to highlight git commands and get copy button.

cjsha commented 2 months ago

@jonnew read this section of the readme about linkchecks. I can fix the broken references in the meanwhile though, if you'd like. Let me know

cjsha commented 2 months ago

Good edits. I added two comments that might clarify the initialization process which we were kinda confused about it earlier.