Skip to content

Commit

Permalink
Implement #344
Browse files Browse the repository at this point in the history
  • Loading branch information
lGuillaume124 committed Sep 16, 2018
1 parent b671134 commit 2e401e0
Showing 1 changed file with 37 additions and 5 deletions.
42 changes: 37 additions & 5 deletions README.md
Expand Up @@ -12,9 +12,41 @@ Let's try the latest version on [sonerezh.bzh/demo]!
Follow us on [Twitter] if you like the project, and don't forget to [support it
making a donation].

The documentation is available on [sonerezh.bzh].
The standard installation instruction are available in the documentation on
[sonerezh.bzh]. If you want to contribute to the project or if you prefer to use
Git and Composer you can follow the steps below.

[sonerezh.bzh/demo]: (https://www.sonerezh.bzh/demo/login)
[Twitter]: (https://twitter.com/snrzh)
[support it making a donation]: (https://www.sonerezh.bzh/donate)
[sonerezh.bzh]: (https://www.sonerezh.bzh)
## Installation using Git and Composer

You must have [Composer] installed and ready to download the Sonerezh's
dependencies. You will also need PHP (obviously) and at least ``php-mysql`` or
``php-pgsql`` and ``php-gd``.

1. Download the sources:

```sh
$ git clone https://github.com/Sonerezh/sonerezh.git
```

2. Download the dependencies:

```sh
$ cd sonerezh
$ composer install
```

3. You should be good to run Sonerezh using:

```sh
$ cd app/webroot
$ CAKEPHP_DEBUG=1 php -S localhost:8080
```

_Note: you may have some issues to display the cover arts using the built-in PHP
server._

[sonerezh.bzh/demo]: https://www.sonerezh.bzh/demo/login
[Twitter]: https://twitter.com/snrzh
[support it making a donation]: https://www.sonerezh.bzh/donate
[sonerezh.bzh]: https://www.sonerezh.bzh
[Composer]: https://getcomposer.org/

0 comments on commit 2e401e0

Please sign in to comment.