Skip to content

Commit

Permalink
Update README.md (#1)
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Korbeil authored Jul 11, 2019
2 parents 6b16e9f + f3dca64 commit d0be688
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,24 @@ This README does not aim to explain Symfony binary, if you want more details you

# Installation 💾

pomdok is the only thing you have to install, the symfony binary will be automatically installed if not present on your computer.

## Mac

You can install this binary through [Homebrew](https://brew.sh/index_fr):
You can install this binary through [Homebrew](https://brew.sh/):

```bash
brew tap jolicode/pomdok git@github.com:jolicode/pomdok.git
brew install pomdok
```

Or you can follow linux way below 👇

## Linux

Download [last release](https://github.com/jolicode/pomdok/releases), extract it and you'll have the binary. I suggest you to put it in `/usr/local/bin/` to be easier to use but you can do whatever you want 🤷

# Getting started 🚀

First you need a configuration file that we call `pomdok.yaml` in your project root as following:
First, you need a configuration file that we call `pomdok.yaml` in your project root as following:
```yaml
pomdok:
tld: 'test'
Expand All @@ -36,7 +36,7 @@ pomdok:
path: '/apps/back-office'
```
You'll need atleast `tld` field and one project to have a valid configuration.
You'll need at least `tld` field and one project to have a valid configuration.

To init `pomdok` for your project run:
```bash
Expand All @@ -57,7 +57,7 @@ pomdok stop
## Symfony related
To make pomdok works, we're using symfony CLI. Some setup on this side is needed:
- You have to setup Symfony CLI proxy (you can find how on [this slide](https://speakerdeck.com/fabpot/symfony-local-web-server-dot-dot-dot-reloaded?slide=32))
- You have to setup Symfony CLI proxy (you can find how on [this slide](https://speakerdeck.com/fabpot/symfony-local-web-server-dot-dot-dot-reloaded?slide=32) or on the [official documentation](https://symfony.com/doc/current/setup/symfony_server.html#setting-up-the-local-proxy))
- And to install Symfony CLI certificate authority through `symfony local:server:ca:install`
# Troubleshooting 🤕
Expand Down

0 comments on commit d0be688

Please sign in to comment.