Fixing typos
authorDavid NĂ©grier <d.negrier@thecodingmachine.com>
Sat, 4 Apr 2020 11:18:45 +0000 (13:18 +0200)
committerGitHub <noreply@github.com>
Sat, 4 Apr 2020 11:18:45 +0000 (13:18 +0200)
README.md

index 0e86a8751467df73de4a935721cfac627c615faf..61ee39f08ae8a847cba08cba73be7bcb5f34b7e0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -30,48 +30,67 @@ Note: on some OSes, you will need to add this line to your `/etc/hosts` file:
 workadventure.localhost 127.0.0.1
 ```
 
-## MacOs developer, your environment with Vagrant
-Increase Docker Performance with Vagrant. If you want more explain you can read: [this medium article](https://medium.com/better-programming/vagrant-to-increase-docker-performance-with-macos-25b354b0c65c).
-### Prerequisites
+### MacOS developers, your environment with Vagrant
+
+If you are using MacOS, you can increase Docker performance using Vagrant. If you want more explanations, you can read [this medium article](https://medium.com/better-programming/vagrant-to-increase-docker-performance-with-macos-25b354b0c65c).
+
+#### Prerequisites
+
 - VirtualBox*  5.x     Latest version  https://www.virtualbox.org/wiki/Downloads
 - Vagrant      2.2.7   Latest version  https://www.vagrantup.com/downloads.html
-### First steps
-Create config file `Vagrantfile` with `Vagrantfile.template`
-````bash
+
+#### First steps
+
+Create a config file `Vagrantfile` from `Vagrantfile.template`
+
+```bash
 cp Vagrantfile.template Vagrantfile
-````
-In `Vagrantfile` Update `VM_HOST_PATH` with your local file path of your machine. 
-````
-#VM_HOST_PATH# => your local machine path of the project
-````
-run `pwd` and copy the path in this variable.
-To start your VM Vagrant, run
-````bash
+```
+
+In `Vagrantfile`, update `VM_HOST_PATH` with the local project path of your machine.
+
+```
+#VM_HOST_PATH# => your local machine path to the project
+
+```
+
+(run `pwd` and copy the path in this variable)
+
+To start your VM Vagrant, run:
+
+```bash
 Vagrant up
-````
-To connect on your VM run 
-````bash
+```
+
+To connect to your VM, run:
+
+
+```bash
 Vagrant ssh
-````
-To start project environment docker, run
-````bash
+```
+
+To start project environment, run
+
+```bash
 docker-compose up
-````
-You environment run in you VM Vagrant. When you want stop your VM, you can run
+```
+
+You environment runs in you VM Vagrant. When you want stop your VM, you can run:
+
 ````bash
 Vagrant halt
 ````
+
 If you want to destroy, you can run
+
 ````bash
 Vagrant destroy
 ````
 
-### Available commands
+#### Available commands
 
 * `Vagrant up`: start your VM Vagrant.
 * `Vagrant reload`: reload your VM Vagrant when you change Vagrantfile.
 * `Vagrant ssh`: connect on your VM Vagrant.
 * `Vagrant halt`: stop your VM Vagrant.
 * `Vagrant destroy`: delete your VM Vagrant.
-
-