search

dsa-ou / m269-installer

Software installation script and instructions for M269
https://dsa-ou.github.io/m269-installer/
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Code "blocks" instead of "inline" code in instructions (README), for faster copy paste #16

Closed densnow closed 1 year ago

densnow commented 1 year ago

Code in written in "blocks" (delimited by ``` in md) allows it to be copied with one click (the box in the top right corner) as opposed to selecting with mouse. E.g.

try to copy this command -h -e -r -e vs

this command right -h -e -r -e

it is certainly not a big deal , but this could make things a little easier during the install process. Maybe a mention of the "click to copy" box could be mentioned in the instructions.

mwermelinger commented 1 year ago

Are you sure that works in the generated GitHub Pages, i.e on https://dsa-ou.github.io/m269-installer?

densnow commented 1 year ago

To be honest I had not considered that!

I have just looked at a couple examples and it looks like it does not carry through :frowning_face: (annoying because readthedocs does keep the boxes).

Doing this would only benefit the normal Github Project page and so may not be worth the effort and potential downgrade in "style". Any mention of a "click to copy" box could certainly confuse things so we can throw that out of the window!

mwermelinger commented 1 year ago

OK, closing with won't do.