search

RuneAudio / Docs

Official documentation of the RuneAudio project.
http://www.runeaudio.com/
45 stars 32 forks source link

Update sd-card-setup-linux.md #8

Closed pawelad closed 9 years ago

pawelad commented 9 years ago

Based on the given source and the doc for Windows. Please check for spelling mistakes.

ACXgit commented 9 years ago

Hi pawelad, thank youvery much for your contribution. Im going to merge this now although there are some things to fix before publishing it.

I took a quick view at the contents and there's a problem with the ordered list under the "Materials" section: the [INFO] block has to be before or after the list to avoid to break it. You can see that here: https://github.com/pawelad/Docs/blob/patch-1/docs/quick-start/sd-card-setup-linux.md

I'm also not sure about the very long [INFO] block near the end, I have to see how it looks with proper styles.

pawelad commented 9 years ago

All of that was based on the doc for Windows - https://github.com/pawelad/Docs/blob/patch-1/docs/quick-start/sd-card-setup-windows.md - so that there would be the same 'style'. I personally think that Materials block could be deleted all together, but I figured that the best example to follow will be the doc already approved by you.

And I agree that the INFO block shouldn't be this long. It's just that the command is very powerful and the path to the card is very important; I personally had a problem whether I should put mmcblk0 or mmcblk0p1 when I first installed it.

Should I try to change it, or just leave it and let somebody else do it?

ACXgit commented 9 years ago

I would move "Intro" and "Materials" out into the "Prepare the SD card" section of Quick start guide, as they are common instructions for all the platforms. The same should be done for all the three specific guides (Windows, Mac and Linux).

The [INFO] block contains very important informations but we shouldn't put it all inside that, just below. I think that a combination of a [WARNING] block with some bold elements under it should be enough. These blocks have to be used with moderation, otherwise the content will appear cluttered.

If you can apply this changes it would be very appreciated, as you are saving me a lot of precious time :)

pawelad commented 9 years ago

Should be OK now, but don't hesitate to tell me if you would change anything else - I have a bit of an OCD so it's all good ; )

ACXgit commented 9 years ago

Everything ok, I just applied some small fixes around, for example formatting all the text related with command line with the code tag, e.g.: sudo dcfldd bs=1M if=[img_file_path] of=/dev/[sd_name]

I also updated the docs on the website with the new content: http://www.runeaudio.com/documentation/quick-start/sd-card-setup-linux/

pawelad commented 9 years ago

Cool, cool, cool : )