update readme

README.md

@@ -1,34 +1,46 @@
+This repository helps you to set up a local Mobilizon and a local WordPress instance for developing within minutes.
 
-1. Requirements
+## Step by Step Guide
+
+### 1. Requirements
 - `make`
 - `docker` and `docker-compose`
 - `mkcert` to handle locally trusted SSL certificates.
 
-2. Clone Mobilizon source
+### 2. Clone Mobilizon source
 ```bash
-cd mobilizon && git clone https://framagit.org/framasoft/mobilizon.git
+git clone https://framagit.org/framasoft/mobilizon.git mobilizon/mobilizon
 ```
 
-3. Generate a local certificate which is used for both WordPress and Mobilizon.
+### 3. Generate a SSL-cert
+Generate a local SSL-certificate which is used for both WordPress and Mobilizon.
 ```bash
 mkcert -install -cert-file certs/lan.pem -key-file certs/lan-key.pem wp.lan mz.lan
 ```
 
-4. Add the two dummy domains to the /etc/hosts file on your machine:
+### 4. Add the two dummy domains to the /etc/hosts file on your machine:
 ```
 127.0.0.1   wp.lan
 127.0.0.1   mz.lan
 ```
 
-5. Build Mobilizon via running `make setup`
+### 5. Build Mobilizon
+`make setup`
 
-5. Start the docker containers via `make start`
+### 6. Start the docker containers
+`make start`
 
-6. Go to http://wp.lan and setup WordPress
+### 7. Go to http://wp.lan and setup WordPress
+Currently this has to be done manually: 
+- Go to http://wp.lan and enter dummy credentials.
+- Install the WordPress plugins you need.
 
-7. Create an administrator user for Mobilizon
+### 8. Create an administrator user for Mobilizon
 ```
 docker-compose exec mobilizon mix mobilizon.users.new "your@email.com" --admin --password "mypassword"
 ```
 
-8. Get the logs via `docker-compose logs -f <container_name>` or `make logs`.
+### 9. Start developing and debuggin
+Get the logs via 
+- `docker-compose logs -f <container_name>`
+- `make logs`