search

maximkulkin / esp-homekit-demo

Demo of Apple HomeKit accessory server library
MIT License
809 stars 233 forks source link

Update build instructions so folders with spaces work #288

Closed njdancer closed 4 years ago

njdancer commented 4 years ago

When following the build instructions from the wiki(which are generally great btw. Thanks!) the docker run command will fail if the working directory has any spaces in it and the following error is presented.

docker: invalid reference format: repository name must be lowercase.

This can be resolved by wrapping the path in double quotes so this,

docker run -it --rm -v `pwd`:/project -w /project esp-rtos make -C examples/sonoff_basic all

becomes

docker run -it --rm -v "`pwd`":/project -w /project esp-rtos make -C examples/sonoff_basic all

.

I would update this myself but it appears only contributors can edit the wiki.

njdancer commented 4 years ago

So from what I can tell make doesn't handle folders with spaces in them at all so even after working around this I couldn't get it to work without ensuring the pwd contains no spaces. As such this wiki change is pointless but it may be worthwhile adding a note to use only folders without spaces as the docker error is not particularly helpful.

maximkulkin commented 4 years ago

IMO using computers assumes some base level of competency and babysitting newbies is not the most enjoyful way to spend your personal time. But I've fixed that particular case in documentation for you.