diff --git a/README.md b/README.md index d313962880..6de460624d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ EspoCRM is an Open Source CRM (Customer Relationship Management) software that allows you to see, enter and evaluate all your company relationships regardless of the type. People, companies or opportunities - all in an easy and intuitive interface. +### How to get started + +1. Clone repository to your local computer. +2. Change to the project's root directory. +3. Install [composer](https://getcomposer.org/doc/00-intro.md). +4. Run `composer install` if composer is installed globally or `php composer.phar install` if locally. + +Never update composer dependencies if you going to contribute code back. + +Now you can build. + +If your repository is accessible via a web server then you can access to EspoCRM by url `http://URL/frontend` w/o making the build. You will need yo have proper data/config.php and existing database. + ### How to build You need to have nodejs installed.