search

andymccurdy / tested-transcoder

MIT License
56 stars 14 forks source link

Add additional instructions and clean up README. #1

Closed eseglem closed 9 years ago

eseglem commented 9 years ago

I attempted to clean up a few things in the README.

Fixed a typo or two. All prerequisite links now go directly to the download pages. Added a couple code blocks. Separated Installation from Usage.

I also added a section about testing to VT-x support on the machine before attempting to use vagrant. It had somehow became disabled in my BIOS, and it broke the initial vagrant up without me realizing the cause. For a user less familiar to VirtualBox this could be a real problem. It might be worth considering defaulting to 1 CPU core, which would not need it, and allowing advanced users to enable multi-core support themselves.

notthatwillsmith commented 9 years ago

Thanks, that's great!

FYI, we defaulted to four cores because users on Windows will jack up the vagrant script if they edit it with Notepad. Newlines and all that. Four seems to be the most common according to Steam, etc.

eseglem commented 9 years ago

I meant edit the number of cores after creation in VirtualBox so you don't run into the visualization error as I did, and would not need to edit the Vagrantfile.

I am currently playing with a .bat file that prompts for all the variables and would greatly simplify install for beginners. Once I get it working I'll translate it to .sh for Ubuntu as well.

andymccurdy commented 9 years ago

I think it would be reasonable to prompt from the vagrantfile. We could detect if vagrant was called with the "up" or "reload" command and trigger the prompt from that.

FYI there are environment variables that can be set to override the default cpu and memory settings too.

eseglem commented 9 years ago

I did not think there is any way prompt for user input within vagrant itself.

I have been playing with a bat file that sets the environment variables through prompts and then runs vagrant up. Which seems to be reasonable, but prompting within vagrant would certainly be more universal.