improve installation related doc and settings (#122)

configure composer to use git for phpactor's packages. This makes it
easier to start contributing to phpactor itself as it's just a matter
of working with git under ~/.emacs.d/phpactor/vendor/phpactor

add notice in the README about where phpactor is installed

add second installation possibility using straight.el

move completion elisp related config to ad hoc section in README

Author: kermorgant

README.org

@@ -9,32 +9,54 @@ This package is Emacs interface to [[http://phpactor.github.io/phpactor/][Phpact
 <a href="http://melpa.org/#/phpactor"><img alt="MELPA: phpactor" src="http://melpa.org/packages/phpactor-badge.svg"></a>
 <a href="http://stable.melpa.org/#/phpactor"><img alt="MELPA stable: phpactor" src="http://stable.melpa.org/packages/phpactor-badge.svg"></a>
 #+END_HTML
-** Instalation
+** Installation
 
 *Requirement*: You need to have composer globally installed.
 
-Installation with use-package :
+*** First step
+**** Installation with use-package :
 
-#+BEGIN_SRC emacs-lisp
-(use-package phpactor :ensure t)
-(use-package company-phpactor :ensure t)
-(use-package php-mode
-  ;;
-  :hook ((php-mode . (lambda () (set (make-local-variable 'company-backends)
-       '(;; list of backends
-         company-phpactor
-         company-files
-         ))))))
-#+END_SRC
+ #+BEGIN_SRC emacs-lisp
+ (use-package phpactor :ensure t)
+ (use-package company-phpactor :ensure t)
+ #+END_SRC
+
+**** Installation with straight.el
+
+ (here using straight.el with use-package)
 
-After having installed this package, run `phpactor-install-or-update` (this will install a supported version of phpactor inside `.emacs.d/phpactor`).
+ #+BEGIN_SRC emacs-lisp
+ (use-package phpactor
+   :straight (phpactor
+              :host github
+              :type git
+              :repo "emacs-php/phpactor.el"
+              :branch "master"
+              :files ("*.el" "composer.json" "composer.lock" (:exclude "*test.el"))
+              )
+   )
+ #+END_SRC
 
-*NOTICE*: To ensure the supported version of Phpactor is installed, you might need to run this command again after an upgrade of this package.
+*** Second step
+ After having installed this package, run `phpactor-install-or-update` (this will install a supported version of phpactor inside `.emacs.d/phpactor`).
 
-Alternatively, you can install Phpactor on your own and configure `phpactor-executable` but please be aware that any change in Phpactor's rpc protocol can introduce breakages.
+ *NOTICE*: To ensure the supported version of Phpactor is installed, you might need to run this command again after an upgrade of this package.
+
+ Alternatively, you can install Phpactor on your own and configure `phpactor-executable` but please be aware that any change in Phpactor's rpc protocol can introduce breakages.
 
 
 ** Configuration
+*** completion
+#+BEGIN_SRC emacs-lisp
+ (use-package php-mode
+   ;;
+   :hook ((php-mode . (lambda () (set (make-local-variable 'company-backends)
+        '(;; list of backends
+          company-phpactor
+          company-files
+          ))))))
+#+END_SRC
+
 *** eldoc integration
 
 #+BEGIN_SRC elisp
@@ -89,3 +111,17 @@ You can run ``phpactor-status`` while visiting a project file.
 If needed, configure [[https://github.com/emacs-php/php-mode/blob/1f04813f46219e626b385d0d96abefad914bfae0/php-project.el#L54][the way the project root is detected]] via .dir-locals.el
 
 "*Phpactor Output*" buffer might also contain useful informations.
+
+** About Phpactor
+
+We will assume your emacs configuration is stored under "~/.emacs.d/"
+
+*** Where is phpactor installed
+
+    After running `phpactor-install-or-update`, phpactor should be installed under "~/.emacs.d/phpactor/".
+    And the phpactor executable should be "~/.emacs.d/phpactor/vendor/bin/phpactor"
+
+*** Contribute to phpactor
+
+    Phpactor's packages are cloned (using git) under "~/.emacs.d/phpactor/vendor/phpactor".
+    If you make a modification to phpactor you'd like to contribute, you can just of git straight away to open a pull request therefrom.

composer.json

@@ -24,7 +24,10 @@
         "classmap-authoritative": true,
         "discard-changes": true,
         "optimize-autoloader": true,
-        "preferred-install": "dist",
+        "preferred-install": {
+            "phpactor/*": "source",
+            "*": "dist"
+        },
         "sort-packages": true,
         "platform": {
             "php": "7.1.3"