Lots of README cleanup - Githubissues

gansbrest / hodor

Small utility to streamline dev process with Docker on OS X (Boot2Docker/Docker Machine) and Linux

MIT License

154 stars 11 forks source link

Lots of README cleanup #18

Closed mikeatlas closed 8 years ago

mikeatlas commented 8 years ago

Mac is the hardware name for Apple products running OS X, which the proper OS name. Darwin, the core OS underneath OS X, is an Apple-derived Mach-kernel plus various BSD components, so I changed it to OS X where appropriate throughout.
Consistency with parenthesis spacing in English prose (this) instead of ( that ).
Fixed broken link markdown to author's blog posts.
Changed instructions for OS X install via homebrew for unison pinned to 2.40, which is the (presently unpinned) version in the helper image of gansbrest/fs-base.
Cleaned up sample .hodorfile with yaml markdown formatting.
A little bit of grammar changes and fixes, although I tried to preserve the humor and ESL gentle mistakes, which are harmless, and, in my opinion, bring personality to this project, rather than making it read like all the other dull tech documentation.
Added an Unsupported section

mikeatlas commented 8 years ago

Also, perhaps you might consider updating the project's GitHub description as well from "Boot2Docker VM ( Mac )" to just "Docker on OS X" to be more correct since hodor supports Boot2Docker and docker-machine, both of which are primarily targeted (but not exclusively, AFAIK) by Docker for use on OS X.

gansbrest commented 8 years ago

Ha, thanks a lot. It seem like there are some confilcts with master, could you pull master to your fork and resolve it, so it could be cleanly merged in.

As for description - we def can rename it into somth more meangingfull. "Docker on OS X" prob will not cut it, because Hodor is supported by both OS X and Linux. The goal is to provide consitent dev flow on Mac and Linux (no Windows yet), where if Linux is detected, it skips all Unison/VM/portMapping cruft and start using native volume mounting. I almost dailiy use Hodor for developent on Linux and I know people who use it for mixed Linux/OS X teams. I suggest we come up with somth that will reflect "process" crossplatform orientation. Thoughts?

mikeatlas commented 8 years ago

:+1: I totally support seamless usage of hodor across OS X and Linux... Just wanted to clarify that "Mac" in your description here is like calling Linux "Dell" or "HP", even though technically OS X is only supposed to run on Apple Mac hardware.

Anyhoo, here's the merge fix.

mikeatlas commented 8 years ago

Great :))

gansbrest commented 8 years ago

Thank you! I updated description a bit to remove Mac :) I wonder what changed in new Unison version?