Ghost-Vagrant icon indicating copy to clipboard operation
Ghost-Vagrant copied to clipboard

Improve README.md

Open sebgie opened this issue 9 years ago • 1 comments

Our current readme is very minimalistic (Changlog has more lines than Instructions) and doesn't really explain what is going on behind the curtain. For new contributors this is not very helpful since they are able to get a new VM up and running within minutes, but don't know how to customize it without reading Vagrant or Puppet documentation.

In my opinion it would be good to answer the the following list of questions along with install and usage instructions.

  • What software is available on the VM?
  • What services are running after vagrant up?
  • How to start/stop/restart/provision an existing VM?
  • What does vagrant ssh do?
  • How to mount a custom directory? (see #72)
  • Why would I want to use Ghost-Vagrant and how does it help my Ghost development?
  • How to use the preconfigured SSL certificates?
  • ...?

sebgie avatar Dec 09 '15 12:12 sebgie

This would be very helpful

stantond avatar Mar 05 '16 11:03 stantond