doc->[add] code blocks under advanced section for readability.

openworm / OpenWorm

Repository for the main Dockerfile with the OpenWorm software stack and project-wide issues

http://openworm.org

MIT License

2.57k stars 206 forks source link

doc->[add] code blocks under advanced section for readability. #354

Open p0lyMth opened 5 days ago

p0lyMth commented 5 days ago

MOTIVATION The purpose of this update is to improve readability for future readers. Under the advanced section, it was not clear what command was associated with the -d option. So I included two code blocks, which explicitly show readers how to invoke the run command with the -d option, either in MacOS/Linux or Windows.

Signed-off-by: michaelsodeke@outlook.com

pgleeson commented 4 days ago

Hi @p0lyMth. Thanks for the suggested changes. However, this is a PR from a branch with experimental changes to the master branch and so includes a lot of commits that are not ready to be merged. Can you create a new branch from development and open a PR to that? Thanks!

p0lyMth commented 3 days ago

Hello @pgleeson,

I'm new to contributing to other repos I don't own. So, correct me if I'm wrong regarding your response -- do you mean switch the base branch from master to development? If yes, then I've already done this. If not, please clarify.

Cheers.