search

Freeseer / freeseer

Designed for capturing presentations at conferences. Pre-fill a list of talks to record, record them, and upload them to YouTube with our YouTube Uploader.
http://freeseer.readthedocs.org
GNU General Public License v3.0
216 stars 110 forks source link

Related to #442 - Some changes to Quick-Start guide: add $ signs and clarify Installation for Development #599

Closed benbuckley closed 9 years ago

benbuckley commented 9 years ago

I added a few sentences to the Installation for Development section, putting the link to the Github instructions in an introductory paragraph rather than hidden at the end. I have also put a $ at the beginning of each command line instruction for the sake of consistency.

zxiiro commented 9 years ago

Personally I'm not a fan of dollar signs because if you have multi-line commands it makes it much more difficult for someone to just copy paste all the lines into their terminal. In all the cases here we don't have multi-line commands but something to keep in mind when writing documentation. (personally I think as long as the commands appear in a boxed view that clearly identifies itself as a command view, that is sufficient)

Also while bash uses $ for prompt, bash isn't the only shell out there and $ isn't always used as the prompt in alternative shells ;)

benbuckley commented 9 years ago

Either way, it was inconsistent before.

zxiiro commented 9 years ago

Thanks for making it consistent!

dideler commented 9 years ago

Thanks @benbuckley. Can you squash the commits and follow these commit message guidelines, then we can merge this in.

Let us know if you need a hand with squashing (someone will be available on IRC, just ping one of us).

benbuckley commented 9 years ago

Did I do it right?

dideler commented 9 years ago

Thanks for the contribution!