update readme

This commit is contained in:
Yuri Kuznetsov
2014-10-01 11:00:09 +03:00
parent 36a4e48a2b
commit a5cb57dcfd
+13
View File
@@ -1,5 +1,18 @@
<a href='http://www.espocrm.com'>EspoCRM is an Open Source CRM</a> (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.